6fbca7b30c
|
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| docs | ||
| src | ||
| static | ||
| .cspell.json | ||
| .gitignore | ||
| .huskyrc | ||
| .lintstagedrc | ||
| .prettierignore | ||
| Jenkinsfile | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| sidebars.js | ||
| tsconfig.json | ||
| yarn.lock | ||
README.md
Description
This repository contains the content of your documentation website.
How to Run Locally
- Clone this repository.
- Install the dependencies:
$ yarn
- 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.