4.2 KiB

Raw Blame History

Logos Docs Template

The template repository for docs using logos-docusaurus-plugins.

Use Cases

Codex docs

How to Run Locally

Clone this repository

$ git clone https://github.com/acid-info/logos-docs-template.git

Install the dependencies:

$ yarn install

Create .env and run the scraping script and

$ yarn scrape

Start the website:

$ yarn start

Visit http://localhost:3000 in your browser

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
Nimbus
Nomos
VacResearch
Acid.info

Example:

presets: [
  [
    '@acid-info/logos-docusaurus-preset',
    {
      businessUnit: 'Codex',
    },
  ],
],

This is typically sufficient for most cases, as the Logos plugins will automatically populate other configurations related to the specified business unit. If you encounter any errors in the information provided by Logos Plugins, please visit the Logos Docusaurus Plugins repository and open an issue.

Docs Setup

This template does not include a landing page. Please review the routeBasePath: '/' setting in the docusaurus.config.js file.

presets: [
    [
      '@acid-info/logos-docusaurus-preset',
      /** @type {import('@acid-info/logos-docusaurus-preset').PluginOptions} */
      ({
        businessUnit: 'Codex',
        theme: {
          name: 'default',
          options: {
            customCss: [require.resolve('./src/css/custom.scss')],
            docs: {
              default: {
                sidebar: {
                  hide: false,
                },
              },
            },
          },
        },
        docs: {
          routeBasePath: '/', // the index.md becomes the index page
        },
        og: {},
      }),
    ]
]

The content in docs/index.md will serve as the root page for your documentation.

For additional customization options, please refer to the Docusaurus Configuration.

Adding docs

To add a document, create a .md or mdx file within the docs directory. You can use Frontmatter to add metadata to your markdown file.

Docusaurus Config

You can find instructions for adding additional documentation sections, implementing localization, and managing versioning on the Docusaurus website.

Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme, visit the Logos Docusaurus Theme repository.

Custom CSS

By default, this template utilizes the CSS styles defined in the logos-docusaurus-plugins package. You have the option to define custom CSS in src/css/custom.scss.

How to Run a Static Build (Production Build)

Generate static files for production:

$ yarn build

The static files will be created in the build directory.

Serve the static build:

$ yarn serve

CI/CD

The master branch is automatically deployed to the production server (e.g., logos.co) through CI
The develop branch is automatically deployed to the staging server (e.g., dev.logos.co) through CI

Change Process

Create a new working branch from develop: git checkout develop; git checkout -b my-changes.
Make your changes, push them to the origin, and open a Pull Request against the develop branch.
After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
When ready to promote changes to the live website, rebase the master branch on the staging changes: git checkout master; git pull origin master; git rebase origin/develop; git push.

4.2 KiB Raw Blame History