waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Waku Documentation Portal https://docs.waku.org
36 Commits 10 Branches 0 Tags 37 MiB
JavaScript 67.4%
Python 18.4%
SCSS 13.8%
TypeScript 0.4%
Go to file
Sasha f8f53623ae
Merge pull request #36 from waku-org/dependabot/npm_and_yarn/webpack-5.76.1 
Bump webpack from 5.75.0 to 5.76.1
 		2023-03-15 21:11:06 +01:00
.github/workflows feat: improvements on docs (#24) 2022-12-19 16:56:42 +05:30
.vscode Squashed commit of the following: 2022-11-08 10:42:05 +11:00
docs chore: refactor ordering/naming of markdown files (#29) 2022-12-23 16:59:16 +05:30
src feat: use Logos theme & plugin (#33) 2023-01-23 15:07:39 +05:30
.cspell.json feat: improvements on docs (#24) 2022-12-19 16:56:42 +05:30
.gitignore Squashed commit of the following: 2022-11-08 10:42:05 +11:00
.huskyrc add: prettier 2022-11-11 19:52:14 +05:30
.lintstagedrc add: prettier 2022-11-11 19:52:14 +05:30
.prettierignore add: prettier 2022-11-11 19:52:14 +05:30
README.md feat: use Logos theme & plugin (#33) 2023-01-23 15:07:39 +05:30
babel.config.js feat: use Logos theme & plugin (#33) 2023-01-23 15:07:39 +05:30
docusaurus.config.js feat: use Logos theme & plugin (#33) 2023-01-23 15:07:39 +05:30
package.json feat: use Logos theme & plugin (#33) 2023-01-23 15:07:39 +05:30
sidebars.js feat: use Logos theme & plugin (#33) 2023-01-23 15:07:39 +05:30
tsconfig.json feat: use Logos theme & plugin (#33) 2023-01-23 15:07:39 +05:30
yarn.lock Bump webpack from 5.75.0 to 5.76.1 2023-03-15 10:21:20 +00:00

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.