# Migrate to Hugo Modules > Convert an existing site to use Docsy as a Hugo Module --- ## 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@vv0.14.4-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@vv0.14.4-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. ```bash cd /path/to/my-existing-site ``` Only sites that are Hugo Modules themselves can import other Hugo Modules. Turn your existing site into a Hugo Module by running the following command from your site directory, replacing `github.com/me/my-existing-site` with your site repository: ```bash hugo mod init github.com/me/my-existing-site ``` This creates two new files, `go.mod` for the module definitions and `go.sum` which holds the checksums for module verification. Next declare the Docsy theme module as a dependency for your site. ```bash hugo mod get github.com/google/docsy@vv0.14.4-dev ``` This command adds the `docsy` theme module to your definition file `go.mod`. ### Update your config file In your `hugo.toml`/`hugo.yaml`/`hugo.json` file, update the theme setting to use Hugo Modules. Find the following line:

theme = ["docsy"]

theme: docsy

"theme": "docsy"

Change this line to:

theme = ["github.com/google/docsy"]

theme:
  - github.com/google/docsy

"theme": [
  "github.com/google/docsy"
]

Alternatively, you can omit this line altogether and replace it with the settings given in the following snippet:

[module]
  proxy = "direct"
  # uncomment line below for temporary local development of module
  # replacements = "github.com/google/docsy -> ../../docsy"
  [module.hugoVersion]
    extended = true
    min = 0.155.3
  [[module.imports]]
    path = "github.com/google/docsy"
    disable = false

module:
  proxy: direct
  hugoVersion:
    extended: true
    min: 0.155.3
  imports:
    - path: github.com/google/docsy
      disable: false
    - path: github.com/google/docsy/dependencies
      disable: false

{
  "module": {
    "proxy": "direct",
    "hugoVersion": {
      "extended": true,
      "min": 0.155.3
    },
    "imports": [
      {
        "path": "github.com/google/docsy",
        "disable": false
      },
      {
        "path": "github.com/google/docsy/dependencies",
        "disable": false
      }
    ]
  }
}

You can find details of what these configuration settings do in the [Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level). Depending on your environment you may need to tweak them slightly, for example by adding a proxy to use when downloading remote modules. > [!TIP] > > In Hugo 0.110.0 the default config base filename was changed to `hugo.toml`. > If you are using hugo 0.110 or above, we recommend renaming your `config.toml` > to `hugo.toml`! > [!CAUTION] > > If you have a multi-language installation, make sure that the section > `[languages]` inside your `hugo.toml` is declared before the section > `[module]` with the module imports. Otherwise you will run into trouble! ### Check validity of your configuration settings To make sure that your configuration settings are correct, run the command `hugo mod graph` which prints a module dependency graph: ```bash hugo mod graph hugo: collected modules in 1092 ms github.com/me/my-existing-site github.com/google/docsy@vv0.14.4-dev github.com/google/docsy@vv0.14.4-dev github.com/twbs/bootstrap@v5.2.3+incompatible github.com/google/docsy@vv0.14.4-dev github.com/FortAwesome/Font-Awesome@ v0.0.0-20230802202706-f0c25837a3fe ``` Make sure that three lines with dependencies `docsy`, `bootstrap` and `Font-Awesome` are listed. If not, please double check your config settings. > [!TIP] > > In order to clean up your module cache, issue the command `hugo mod clean` > > ```bash > hugo mod clean > hugo: collected modules in 995 ms > hugo: cleaned module cache for "github.com/FortAwesome/Font-Awesome" > hugo: cleaned module cache for "github.com/google/docsy" > hugo: cleaned module cache for "github.com/twbs/bootstrap" > ``` ## Clean up your repository Since your site now uses Hugo Modules, you can remove `docsy` from the `themes` directory, as instructed below. First, change to the root directory of your site: ```bash cd /path/to/my-existing-site ``` ### Previous use of Docsy theme as git clone Simply remove the subdirectory `docsy` inside your `themes` directory: ```bash rm -rf themes/docsy ``` ### Previous use of Docsy theme as git submodule If your Docsy theme was installed as submodule, use git's `rm` subcommand to remove the subdirectory `docsy` inside your `themes` directory: ```bash git rm -rf themes/docsy ``` You are now ready to commit your changes to your repository: ```bash git commit -m "Removed docsy git submodule" ``` > [!CAUTION] > > Be careful when using the `rm -rf` command, make sure that you don't > inadvertently delete any productive data files!