Acid Info website repo https://acid.info
Go to file
Hossein Mehrabi c260b57603 update .gitignore 2023-06-09 05:43:21 +03:30
.docusaurus upgrade to v1 2023-06-06 15:14:30 +02:00
docs upgrade to v1 2023-06-06 15:14:30 +02:00
src upgrade to v1 2023-06-06 15:14:30 +02:00
static upgrade to v1 2023-06-06 15:14:30 +02:00
.gitignore update .gitignore 2023-06-09 05:43:21 +03:30
Jenkinsfile fix jenkinsfile 2023-06-07 22:01:25 +01:00
README.md upgrade to v1 2023-06-06 15:14:30 +02:00
babel.config.js upgrade to v1 2023-06-06 15:14:30 +02:00
docusaurus.config.js upgrade to v1 2023-06-06 15:14:30 +02:00
package.json upgrade to v1 2023-06-06 15:14:30 +02:00
sidebars.js upgrade to v1 2023-06-06 15:14:30 +02:00
tsconfig.json upgrade to v1 2023-06-06 15:14:30 +02:00
yarn.lock upgrade to v1 2023-06-06 15:14:30 +02:00

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.