Go to file
Hossein Mehrabi dc5318980b feat: upgrade logos preste && replace hero model with a pre-rendered video 2023-07-04 18:18:55 +03:30
.github Create dependabot.yml 2023-06-13 13:24:33 +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 terms content 2023-06-09 23:46:50 +09:00
src feat: upgrade logos preste && replace hero model with a pre-rendered video 2023-07-04 18:18:55 +03:30
static feat: upgrade logos preste && replace hero model with a pre-rendered video 2023-07-04 18:18:55 +03:30
.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: fix negative conditional for devel deployment 2023-06-23 11:48:09 +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 feat: upgrade logos preste && replace hero model with a pre-rendered video 2023-07-04 18:18:55 +03:30
package.json feat: upgrade logos preste && replace hero model with a pre-rendered video 2023-07-04 18:18:55 +03:30
tsconfig.json implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
yarn.lock feat: upgrade logos preste && replace hero model with a pre-rendered video 2023-07-04 18:18:55 +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.