Update Docsy on Docsy

Update your Docsy Hugo Module

Mon, 01 Jan 0001 00:00:00 +0000

At the command prompt, change to the root directory of your existing site.

cd /path/to/my-existing-site

Then invoke Hugo’s module get subcommand with the update flag:

hugo mod get -u github.com/google/docsy/theme

Hugo automatically pulls in the latest theme version.

Tip

To pin the theme to a specific version, specify its tag when updating, for example:

hugo mod get github.com/google/docsy/theme@v0.16.0

Instead of a version tag, you can also specify a commit hash, for example:

Update your Docsy NPM package

Mon, 01 Jan 0001 00:00:00 +0000

Update the theme to the latest release by running the following from your project root:

npm install --save-dev @docsy/theme@latest

Tip

To pin a specific version, name it explicitly, for example:

npm install --save-dev @docsy/theme@v0.16.0

To verify the resolved version of @docsy/theme, run:

npm ls @docsy/theme --depth=0

If your site installs Docsy from GitHub with npm (a mode reserved for Docsy development and testing), update by re-running the install command with the desired revision selector.

Update your Docsy Git submodule or clone

Mon, 01 Jan 0001 00:00:00 +0000

Use the procedure matching how Docsy was installed in your project: submodule or clone.

Tip

To simplify future updates, consider switching to the Docsy NPM package or converting your site to Hugo Modules.

Update your Docsy submodule

If you are using the Docsy theme as a submodule in your project, here’s how you update the submodule to the latest release:

Navigate to the root of your local project, then update the submodule to the release tag that you are targeting, for example:

Migrate to Hugo Modules

Mon, 01 Jan 0001 00:00:00 +0000

TL;DR: Conversion for the impatient expert

Run the following from the command line:

cd /path/to/my-existing-site
hugo mod init github.com/me-at-github/my-existing-site
hugo mod get github.com/google/docsy/theme@v0.16.0
sed -i '/theme = \["docsy/d' config.toml
mv config.toml hugo.toml
cat >> hugo.toml <<EOL
[module]
proxy = "direct"
[[module.imports]]
path = "github.com/google/docsy/theme"
EOL
hugo mod npm pack
npm install
hugo server

cd my-existing-site
hugo mod init github.com/me-at-github/my-existing-site
hugo mod get github.com/google/docsy/theme@v0.16.0
findstr /v /c:"theme = [\"docsy" config.toml > hugo.toml
(echo [module]^

proxy = "direct"^

[[module.imports]]^

path = "github.com/google/docsy/theme")>>hugo.toml
hugo mod npm pack
npm install
hugo server

Detailed conversion instructions

Import the Docsy theme module as a dependency of your site

At the command prompt, change to the root directory of your existing site.