Repo for the Nimbus website https://nimbus.team
Go to file
Hossein Mehrabi 672ad0a941
update the list of Nimbus users
2023-12-20 20:50:31 +03:30
.husky BREAKING CHANGE: implement docusaurus 2023-06-01 19:37:55 +09:00
about Update clients.md (#160) 2023-12-20 18:55:04 +03:30
docs Update index.md (#158) 2023-12-18 21:56:31 +03:30
root-pages fix discord invitation links 2023-12-15 13:10:30 +03:30
src update the list of Nimbus users 2023-12-20 20:50:31 +03:30
static update the list of Nimbus users 2023-12-20 20:50:31 +03:30
.gitignore feat: enable jobs 2023-12-05 01:21:43 +09:00
.prettierignore BREAKING CHANGE: implement docusaurus 2023-06-01 19:37:55 +09:00
.prettierrc BREAKING CHANGE: implement docusaurus 2023-06-01 19:37:55 +09:00
Jenkinsfile ci: fix conditional for devel publishing 2023-06-05 14:43:46 +02:00
README.md BREAKING CHANGE: implement docusaurus 2023-06-01 19:37:55 +09:00
babel.config.js BREAKING CHANGE: implement docusaurus 2023-06-01 19:37:55 +09:00
docusaurus.config.js Add link to the nimbus `guide` 2023-12-20 17:11:29 +01:00
package.json chore: upgrade @acid-info/logos-docusaurus-preset 2023-12-20 17:47:07 +03:30
tsconfig.json BREAKING CHANGE: implement docusaurus 2023-06-01 19:37:55 +09:00
yarn.lock chore: upgrade @acid-info/logos-docusaurus-preset 2023-12-20 17:47:07 +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.