Skip to content

Add npm script to start development server and update README. #6509

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

Merged
MarkvanMents merged 3 commits into from
Sep 15, 2023
Merged

Add npm script to start development server and update README. #6509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99df4b5
Add npm script to start development server and update README.
lmeijvogel Sep 12, 2023
90eb8db
Add and document alternative npm scripts
MarkvanMents Sep 14, 2023
049d61e
Add additional npm scripts
MarkvanMents Sep 14, 2023
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,12 @@ To clone the repo please keep in mind:

To run a local version of the site:

1. Run cmd: `./node_modules/.bin/hugo server --environment development`
1. Run one of the following commands:

The path syntax prefacing `hugo` may be different based on your operating system and terminal you use.
* `npm run build`
* `./node_modules/.bin/hugo server --environment development` – in this case, you can use [different parameters](https://gohugo.io/commands/hugo_server/) to build the site in different ways—for example, build a copy of the production site and save it locally.

The path syntax prefacing `hugo` may be different based on your operating system and terminal you use.

Once the site is built you will see a table indicating how many pages have been created. You will need to wait until the server is set up before you can see the site.

Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"description": "Node files needed by Docsy",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"start": "hugo server --environment development",
"build": "hugo server --environment development"
},
"repository": {
"type": "git",
Expand Down