Skip to content

Update documentation for local docs website testing #625

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
Sophietje merged 1 commit into from
Mar 6, 2025
Merged

Update documentation for local docs website testing #625

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
7 changes: 6 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ The documentation can be found in the `docs/` directory.
Required:
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.

If you want to use the commands below and this is your first time running/generating the website locally, you'll need to run the following command to install the dependencies:
```bash
npm install
```

### Generate website files
To statically generate the website, within this directory (`knowledge-engine/docs/`), run:
Expand All @@ -31,4 +36,4 @@ npm run start
```

The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
The site will **automatically reload** and display your changes.
The site will **automatically reload** and display your changes.