Docusaurus

Docusaurus is a tool for easily building project websites.

YAML Configuration

docusaurus:

  • config-file

    • Path to the Docusaurus configuration file (siteConfig.js).
    • If this field is omitted:
      • Docstand searches for siteConfig.js under the repository and uses it to build documentation.
      • If siteConfig.js is not found, the documentation job fails.
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.5 CPU with 1920 MiB RAM.

Examples

  • With docusaurus set to default

    docstand:
      docusaurus: default
    
  • With custom machine:

    docstand:
      docusaurus:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With config-file option

    docstand:
      docusaurus:
        config-file: website/siteConfig.js
    

results matching ""

    No results matching ""