Go to file
Hossein Mehrabi 2c836eaf6b
upgrade logos preset
2023-06-19 11:31:37 +03:30
.github remove vercel actions 2023-03-17 12:22:59 +01:00
.husky Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
docs new URL structure for root pages and research posts, refs #115 2023-06-14 22:49:18 +03:30
rlog new URL structure for root pages and research posts, refs #115 2023-06-14 22:49:18 +03:30
src new URL structure for root pages and research posts, refs #115 2023-06-14 22:49:18 +03:30
static/img Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
.gitignore Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
.prettierignore Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
.prettierrc Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
Jenkinsfile Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
README.md Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
babel.config.js Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
docusaurus.config.js upgrade logos preset, enable automatic og image generator, and use logos customized mermaid theme 2023-06-19 10:55:36 +03:30
package.json upgrade logos preset 2023-06-19 11:31:37 +03:30
tsconfig.json Migrate to Docusaurus (#108) 2023-06-07 22:12:28 +01:00
yarn.lock upgrade logos preset 2023-06-19 11:31:37 +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.