Go to file
Hossein Mehrabi e0a4dcd3e1
upgrade logos preset
2023-06-06 13:31:42 +03:30
.husky implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
about update preset and content 2023-06-03 01:48:15 +09:00
root-pages update preset and content 2023-06-03 01:48:15 +09:00
src config ascii for better look 2023-06-05 16:56:19 +02:00
static update preset and content 2023-06-03 01:48:15 +09:00
.gitignore implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
.prettierignore implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
.prettierrc implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
Jenkinsfile ci: push non-master branches to dev stage 2023-06-05 14:41:12 +02:00
README.md implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
babel.config.js implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
docusaurus.config.js upgrade logos preset 2023-06-02 22:39:54 +03:30
package.json upgrade logos preset 2023-06-06 13:31:42 +03:30
tsconfig.json implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
yarn.lock upgrade logos preset 2023-06-06 13:31:42 +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.