Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[UG] NPM install: add npm init and switch to YAML config #2114

Merged
merged 1 commit into from
Nov 6, 2024
Merged

[UG] NPM install: add npm init and switch to YAML config #2114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions userguide/content/en/docs/get-started/other-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,12 +179,12 @@ your project's root directory:
2. Add Docsy as a theme, for example:

```sh
echo 'theme = "docsy"' >> hugo.toml
echo 'theme: docsy' >> hugo.yaml
```

{{% alert title="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, consider renaming your `config.toml` to `hugo.toml`!
In Hugo 0.110.0 the default config base filename was changed to `hugo.*` from `config.*`.
If you are using hugo 0.110 or above, consider renaming your `config.*` to `hugo.*`!
{{% /alert %}}

3. Get Docsy dependencies:
Expand Down Expand Up @@ -258,14 +258,15 @@ You can use Docsy as an NPM module as follows:
1. Create your site and specify Docsy as the site theme:

```sh
hugo new site myproject
hugo new site --format yaml myproject
cd myproject
echo 'theme = "docsy"' >> hugo.toml
echo 'theme: docsy' >> hugo.yaml
```

2. Install Docsy, and postCSS (as [instructed earlier](#install-postcss)):

```console
npm init -y
npm install --save-dev google/docsy#semver:{{% param version %}} autoprefixer postcss-cli
```

Expand All @@ -285,7 +286,7 @@ You can use Docsy as an NPM module as follows:
your site's configuration file:

```sh
echo 'themesDir = "node_modules"' >> hugo.toml
echo 'themesDir: node_modules' >> hugo.yaml
```

As an alternative to specifying a `themesDir`, on some platforms, you can
Expand Down
Loading