Spectacle

Beautiful static documentation generator for OpenAPI/Swagger 2.0.

YAML Configuration

spectacle:

  • config-file

    • Path to the Spectacle configuration file.
    • If this field is omitted, the default configuration file (app/lib/config.js) is used to build the documentation.
  • machine:

    • cpu:

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

  • options:

    Below is the list of supported options:

    Note: Spectacle requires spec file to generate documentation, therefore spec file must be specified using -S or --spec-file option. If spec file is not specified, Docstand fails to build documentation.

      -C, --disable-css            omit CSS generation (default: false)
      -J, --disable-js             omit JavaScript generation (default: false)
      -e, --embeddable             omit the HTML <body/> and generate the documentation content only (default: false)
      -1, --one-file               Embed all resources (CSS and JS) into the same file (default: false)
      -a, --app-dir <dir>          the application source directory (default: app)
      -l, --logo-file <file>       specify a custom logo file (default: null)
      -S, --spec-file <file>       (required) specify spec file (default: null)
    

Examples

  • With spectacle set to minimum settings

    docstand:
      spectacle:
        options:
          --spec-file: docs/my-swagger-file.yml
    
  • With custom machine:

    docstand:
      spectacle:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
        options:
          --spec-file: docs/my-swagger-file.yml
    
  • With customized spectacle

    docstand:
      spectacle:
       options:
          --spec-file: docs/my-swagger-file.yml
          --logo-file: docs/my-company-logo.png
    

results matching ""

    No results matching ""