Skip to content

Commit b3774d6

Browse files
authored
Drop themesDir from NPM script, tweak README, add dict (#219)
1 parent c3a20c9 commit b3774d6

3 files changed

Lines changed: 20 additions & 13 deletions

File tree

.vscode/settings.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"cSpell.words": [
3+
"Docsy",
4+
"Goldydocs"
5+
]
6+
}

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can clone/copy this project and edit it with your own content, or use it as
88

99
In this project, the Docsy theme component is pulled in as a Hugo module, together with other module dependencies:
1010

11-
```bash
11+
```console
1212
$ hugo mod graph
1313
hugo: collected modules in 566 ms
1414
hugo: collected modules in 578 ms
@@ -28,7 +28,7 @@ This is not an officially supported Google product. This project is currently ma
2828

2929
## Using the Docsy Example Project as a template
3030

31-
A simple way to get started is to use this project as a template, which gives you a site project that is set up and ready to use. To do this:
31+
A simple way to get started is to use this project as a template, which gives you a site project that is set up and ready to use. To do this:
3232

3333
1. Click **Use this template**.
3434

@@ -56,7 +56,7 @@ You can find out more about how to install Hugo for your environment in our
5656

5757
Once you've made your working copy of the site repo, from the repo root folder, run:
5858

59-
```
59+
```bash
6060
hugo server
6161
```
6262

@@ -69,7 +69,7 @@ than [Docker Desktop](https://www.docker.com/products/docker-desktop) on
6969
Windows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/)
7070
on Linux.
7171

72-
1. Build the docker image
72+
1. Build the docker image
7373

7474
```bash
7575
docker-compose build
@@ -83,7 +83,7 @@ on Linux.
8383

8484
> NOTE: You can run both commands at once with `docker-compose up --build`.
8585
86-
1. Verify that the service is working.
86+
1. Verify that the service is working.
8787

8888
Open your web browser and type `http://localhost:1313` in your navigation bar,
8989
This opens a local instance of the docsy-example homepage. You can now make
@@ -92,11 +92,11 @@ on Linux.
9292

9393
### Cleanup
9494

95-
To stop Docker Compose, on your terminal window, press **Ctrl + C**.
95+
To stop Docker Compose, on your terminal window, press **Ctrl + C**.
9696

9797
To remove the produced images run:
9898

99-
```console
99+
```bash
100100
docker-compose rm
101101
```
102102
For more information see the [Docker Compose
@@ -106,10 +106,10 @@ documentation](https://docs.docker.com/compose/gettingstarted/).
106106

107107
As you run the website locally, you may run into the following error:
108108

109-
```
110-
hugo server
109+
```console
110+
$ hugo server
111111

112-
INFO 2021/01/21 21:07:55 Using config file:
112+
INFO 2021/01/21 21:07:55 Using config file:
113113
Building sites … INFO 2021/01/21 21:07:55 syncing static files to /
114114
Built in 288 ms
115115
Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache
@@ -120,8 +120,8 @@ See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/instal
120120

121121
Or you may encounter the following error:
122122

123-
```
124-
hugo server
123+
```console
124+
$ hugo server
125125

126126
Error: failed to download modules: binary with name "go" not found
127127
```

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
"author": "Docsy Authors",
88
"license": "Apache-2.0",
99
"bugs": "https://github.com/google/docsy-example/issues",
10+
"spelling": "cSpell:ignore HTMLTEST precheck postbuild -",
1011
"scripts": {
1112
"_build": "npm run _hugo-dev",
1213
"_check:links": "echo IMPLEMENTATION PENDING for check-links; echo",
13-
"_hugo": "hugo --cleanDestinationDir --themesDir ../..",
14+
"_hugo": "hugo --cleanDestinationDir",
1415
"_hugo-dev": "npm run _hugo -- -e dev -DFE",
1516
"_serve": "npm run _hugo-dev -- --minify serve",
1617
"build:preview": "npm run _hugo-dev -- --minify --baseURL \"${DEPLOY_PRIME_URL:-/}\"",

0 commit comments

Comments
 (0)