Go to file
jeangovil 720539cb7e
Initial commit
2023-06-06 13:25:27 +03:30
.husky Initial commit 2023-06-06 13:25:27 +03:30
docs Initial commit 2023-06-06 13:25:27 +03:30
src Initial commit 2023-06-06 13:25:27 +03:30
.gitignore Initial commit 2023-06-06 13:25:27 +03:30
.prettierignore Initial commit 2023-06-06 13:25:27 +03:30
.prettierrc Initial commit 2023-06-06 13:25:27 +03:30
README.md Initial commit 2023-06-06 13:25:27 +03:30
babel.config.js Initial commit 2023-06-06 13:25:27 +03:30
docusaurus.config.js Initial commit 2023-06-06 13:25:27 +03:30
package.json Initial commit 2023-06-06 13:25:27 +03:30
sidebars.js Initial commit 2023-06-06 13:25:27 +03:30
tsconfig.json Initial commit 2023-06-06 13:25:27 +03:30
yarn.lock Initial commit 2023-06-06 13:25:27 +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.