GitBook

Documentation tool for building beautiful books using Markdown or Asciidoc.

YAML Configuration

gitbook:

  • config-file

    • Path to the GitBook configuration file (book.json).
    • If this field is omitted:
      • Docstand searches for book.json under the repository and uses it to build documentation.
      • If book.json is not found, Docstand searches for readme file and runs GitBook with default configuration in the directory containing the readme file.
  • machine:

    • cpu:

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

Examples

  • With gitbook set to default

    docstand:
      gitbook: default
    
  • With custom machine:

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

    docstand:
      gitbook:
        config-file: docs/book.json
    

results matching ""

    No results matching ""