Go to file
fryorcraken.eth 67061361dc
Merge pull request #42 from waku-org/overview-folder
2023-03-22 14:11:30 +11: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 rename main folder to overview 2023-03-22 14:07:12 +11:00
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
Jenkinsfile add jenkinsfile 2023-03-21 22:24:01 +00:00
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 remove unnecessary comments 2023-03-21 22:17:33 +11:00
package.json Use Docusaurus's default theme 2023-03-17 15:12:43 +03:30
sidebars.js rename main folder to overview 2023-03-22 14:07:12 +11:00
tsconfig.json feat: use Logos theme & plugin (#33) 2023-01-23 15:07:39 +05:30
yarn.lock Use Docusaurus's default theme 2023-03-17 15:12: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.