Go to file
jinhojang6 dfded5908a docs: update terms content and preset version 2023-08-04 00:02:51 +09:00
docs docs: update terms content and preset version 2023-08-04 00:02:51 +09:00
src docs: update terms content and preset version 2023-08-04 00:02:51 +09:00
static feat: add temporary landing page 2023-07-14 03:31:46 +09:00
.gitignore feat: add temporary landing page 2023-07-14 03:31:46 +09:00
Jenkinsfile add jenkinsfile 2023-06-07 21:46:39 +01:00
README.md switch to logos docu v1 2023-06-06 15:22:28 +02:00
babel.config.js switch to logos docu v1 2023-06-06 15:22:28 +02:00
docusaurus.config.js docs: update terms content and preset version 2023-08-04 00:02:51 +09:00
package.json docs: update terms content and preset version 2023-08-04 00:02:51 +09:00
sidebars.js switch to logos docu v1 2023-06-06 15:22:28 +02:00
tsconfig.json switch to logos docu v1 2023-06-06 15:22:28 +02:00
yarn.lock docs: update terms content and preset version 2023-08-04 00:02:51 +09: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.