Update Docsy on Docsy

Update your Docsy Hugo Module

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

When using the Docsy theme as a Hugo Module, updating your theme is really easy.

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

Hugo automatically pulls in the latest theme version. That’s it, your update is done!

Tip

If you want to set your module to a certain version inside the Docsy theme repo, simply specify the name of the tag representing this version when updating your theme, for example:

Update Docsy without Hugo Modules

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

If you aren’t using Hugo Modules, depending on how you chose to install Docsy on your existing site, use one of the following two procedures to update your theme.

Tip

If you intend to update your site, consider converting your site to Hugo Modules. After conversion, it’s even simpler to update Docsy!

Update your Docsy submodule

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

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@v0.14.0-dev
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"
EOL
hugo server

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

proxy = "direct"^

[[module.imports]]^

path = "github.com/google/docsy")>>hugo.toml
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.