Jekyll

Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites.

YAML Configuration

jekyll:

  • config-file

    • Path to the Jekyll configuration file (_config.yml).
    • If this field is omitted, Docstand searches for _config.yml under the repository and uses it to build 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:

      -s, --source SOURCE      Custom source directory
      --future                 Publishes posts with a future date
      --limit_posts MAX_POSTS  Limits the number of posts to parse and publish
      --lsi                    Use LSI for improved related posts
      -D, --drafts             Render posts in the _drafts folder
      --unpublished            Render posts that were marked as unpublished
      --strict_front_matter    Fail if errors are present in front matter
      --safe                   Safe mode (defaults to false)
      -p, --plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]  Plugins directory (defaults to ./_plugins)
      --layouts DIR            Layouts directory (defaults to ./_layouts)
      --profile                Generate a Liquid rendering profile
    

Examples

  • With jekyll set to default

    docstand:
      jekyll: default
    
  • With custom machine:

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

    docstand:
      jekyll:
        config-file: docs/_config.yml
    
  • With customized jekyll

    docstand:
      jekyll:
        config-file: src/_config.yml
        options:
          -s: src
          --future:
          --drafts:
    

results matching ""

    No results matching ""