101 lines
2.1 KiB
Markdown
101 lines
2.1 KiB
Markdown
# Waku Documentation Portal
|
|
|
|
[](https://waku.guide/)
|
|
|
|
The Waku Documentation Portal can be accessed at [waku.guide](https://waku.guide) and was built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
|
|
|
## Prerequisites
|
|
|
|
- [Node.js](https://nodejs.org/en/)
|
|
- [yarn](https://yarnpkg.com/en/)
|
|
|
|
## Installation
|
|
|
|
Clone this repository:
|
|
|
|
```bash
|
|
git clone https://github.com/waku-org/waku.guide
|
|
```
|
|
|
|
Install the dependencies:
|
|
|
|
```bash
|
|
npm install
|
|
|
|
# or
|
|
|
|
yarn install
|
|
```
|
|
|
|
## Running Locally
|
|
|
|
```bash
|
|
npm start
|
|
|
|
# or
|
|
|
|
yarn start
|
|
```
|
|
|
|
Check for spelling errors before deploying:
|
|
|
|
```bash
|
|
npm run check:spell
|
|
|
|
# or
|
|
|
|
yarn check:spell
|
|
```
|
|
|
|
Create a production build locally to check for errors:
|
|
|
|
```bash
|
|
npm run build
|
|
npm run serve
|
|
|
|
# or
|
|
|
|
yarn build
|
|
yarn serve
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Edit the `docusaurus.config.js` file located in the repository's root directory, and update the `businessUnit` field within the presets section. Here is a list of valid values for this field:
|
|
|
|
- Logos
|
|
- Codex
|
|
- Waku
|
|
|
|
Example:
|
|
|
|
```js
|
|
presets: [
|
|
[
|
|
'@acid-info/logos-docusaurus-preset',
|
|
{
|
|
businessUnit: 'Waku',
|
|
},
|
|
],
|
|
],
|
|
```
|
|
|
|
This should suffice since Logos plugins will handle other configurations linked to the designated business unit. However, if you encounter any inaccuracies in the data provided by Logos Plugins, please visit the [Logos Docusaurus Plugins](https://github.com/acid-info/logos-docusaurus-plugins) page and submit an issue.
|
|
|
|
## Customization
|
|
|
|
You can find the instructions on adding more documentation sections, localization, and versioning on the [Docusaurus](https://docusaurus.io/docs) website.
|
|
|
|
> Note that theme customization is limited; for further instructions on customizing your theme, head over to [Logos Docusaurus Theme](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/).
|
|
|
|
## Troubleshooting
|
|
|
|
Docusaurus depends heavily on caching to enhance site performance. If you make changes that do not appear in the portal, try clearing the cache by running:
|
|
|
|
```bash
|
|
npm run clear
|
|
|
|
# or
|
|
|
|
yarn clear
|
|
``` |