Waku.org https://waku.org
Go to file
Hossein Mehrabi fabf0e38e3 update content & configuration 2023-06-02 02:41:43 +03:30
.husky BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
about update content & configuration 2023-06-02 02:41:43 +03:30
root-pages update content & configuration 2023-06-02 02:41:43 +03:30
src update content & configuration 2023-06-02 02:41:43 +03:30
static update content & configuration 2023-06-02 02:41:43 +03:30
.gitignore BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
.prettierignore BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
.prettierrc BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
Jenkinsfile BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
README.md BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
babel.config.js BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
docusaurus.config.js update content & configuration 2023-06-02 02:41:43 +03:30
package.json update content & configuration 2023-06-02 02:41:43 +03:30
tsconfig.json BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
yarn.lock update content & configuration 2023-06-02 02:41:43 +03:30

README.md

Description

This repository contains the content of your documentation website.

How to Run Locally

  1. Clone this repository.
  2. Install the dependencies:
$ yarn
  1. Start and open the website in your browser:
$ yarn start

Configuration

Edit the docusaurus.config.js file in the repository's root directory, and update the value of the businessUnit field in presets section; below is a list of valid values:

  • Logos
  • Codex
  • Waku

Example:

presets: [
  [
    '@acid-info/logos-docusaurus-preset',
    {
      businessUnit: 'Codex',
    },
  ],
],

This is probably enough in most cases, as the Logos plugins will fill in other configurations related to the specified business unit. If you find any error in the information coming from Logos Plugins, please head over to Logos Docusaurus Plugins and create an issue.

Customization

You can find the instructions on adding more documentation sections, localization, and versioning on the Docusaurus website.

Note that theme customization is limited; for further instructions on customizing your theme, head over to Logos Docusaurus Theme.