ornate_2.12.0.6.source-code.ornate-reference.conf Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ornate_2.12 Show documentation
Ornate is a tool for building multi-page HTML sites from Markdown sources.
The newest version!
# Settings which are only accessed globally (overriding on a per-page basis has no effect)
#--doc-global
global {
  # Directory containing the document sources
  sourceDir = "src"
  # Directory containing static resources that should be copied to the target site
  resourceDir = ${global.sourceDir}
  # Array of gitignore-style patterns (relative to global.resourcedir) matching
  # resources that should not be copied
  excludeResources = ["*.md", ".DS_Store", "Thumbs.db", "*~"]
  # Directory to which the output is rendered
  targetDir = "target"
  # TOC structure or null for no TOC
  toc = null
#--doc-global
  # Maximum header level to show in the TOC
  tocMaxLevel = 7
  # Merge page and first heading in the TOC (omit page entry, but make first heading link to page)
  tocMergeFirst = true
  # Allow site: links to pages with target suffix
  allowTargetLinks = false
  # The number of threads for parallel processing, or null for using the detected number of CPU cores
  numThreads = null
  # Short names for extensions
  extensionAliases = {
    #--doc-extension-aliases
    autolink             = org.commonmark.ext.autolink.AutolinkExtension
    ins                  = org.commonmark.ext.ins.InsExtension
    strikethrough        = org.commonmark.ext.gfm.strikethrough.StrikethroughExtension
    tables               = org.commonmark.ext.gfm.tables.TablesExtension
    mathSyntax           = com.novocode.ornate.commonmark.MathSyntaxExtension
    headerAttributes     = com.novocode.ornate.commonmark.HeaderAttributesExtension
    blockQuoteAttributes = com.novocode.ornate.commonmark.BlockQuoteAttributesExtension
    autoIdentifiers      = com.novocode.ornate.commonmark.AutoIdentifiersExtension
    mergeTabs            = com.novocode.ornate.commonmark.MergeTabsExtension
    superscript          = com.novocode.ornate.commonmark.SuperscriptExtension
    subscript            = com.novocode.ornate.commonmark.SubscriptExtension
    smartQuotes          = com.novocode.ornate.commonmark.SmartQuotesExtension
    smartPunctuation     = com.novocode.ornate.commonmark.SmartPunctuationExtension
    includeCode          = com.novocode.ornate.IncludeCodeExtension
    renderMarkdown       = com.novocode.ornate.RenderMarkdownExtension
    expandVars           = com.novocode.ornate.ExpandVarsExtension
    emoji                = com.novocode.ornate.EmojiExtension
    globalRefs           = com.novocode.ornate.GlobalRefsExtension
    scaladocLinks        = com.novocode.ornate.ScaladocLinksExtension
    externalLinks        = com.novocode.ornate.ExternalLinksExtension
    highlightjs          = com.novocode.ornate.highlight.HighlightJSExtension
    #--doc-extension-aliases
  }
  # Short names for themes
  themeAliases = {
    default              = com.novocode.ornate.theme.default.DefaultTheme
    pdf                  = com.novocode.ornate.theme.pdf.PdfTheme
    clean                = com.novocode.ornate.theme.Clean
    dump                 = com.novocode.ornate.theme.Dump
  }
#--doc-global
  # The theme, which also determines the output format
  theme = default
}
#--doc-global

#--doc-extensions
# Extensions (alias or class name) to use on the page
extensions = [
  headerAttributes
  blockQuoteAttributes
  #autolink
  #ins
  strikethrough
  #superscript
  #subscript
  tables
  autoIdentifiers
  includeCode
  expandVars
  renderMarkdown
  mathSyntax
  mergeTabs
  emoji
  globalRefs
  scaladocLinks
  externalLinks
  #smartQuotes
  #smartPunctuation
  highlightjs
]
#--doc-extensions

# Page meta-data
meta {
  # Site title
  siteTitle = "Generated Site"
  # Language code, for example "eng" or "eng-US"
  lang = eng
  # Rendering direction ("ltr" or "rtl")
  dir = ltr
  # Copyright notice
  copyright = ""
}

# The rest of this file contains configurations for configurable objects. These are rooted at $kind.$name
# where kinds include "theme" and "extension", and the name is either an alias or a fully qualified class
# name (only if no alias for that class is defined).

#--doc-emoji
# Emoji format (svg, png, png_128x128, png_512x512, unicode)
extension.emoji.global.format = svg
#--doc-emoji

#--doc-expandVars
extension.expandVars {
  # Start and end delimiter for variable substitution:
  startDelimiter = "{{"
  endDelimiter   = "}}"
  # Whether to expand variables globally in different node types:
  text              = false // in plain text content
  code              = false // in inline code
  indentedCodeBlock = false // in indented code blocks
  fencedCodeBlock   = false // in fenced code blocks
                            // (can be overridden with expandVars=true|false attribute)
}
#--doc-expandVars

#--doc-includeCode
extension.includeCode {
  # Regular expressions (per file suffix) of lines to remove from snippets
  remove = {
    java  = "\\s*//#.*"
    scala = ${extension.includeCode.remove.java}
    sbt   = ${extension.includeCode.remove.java}
  }
}
#--doc-includeCode

#--doc-globalRefs
extension.globalRefs {
  # A map of reference labels to targets
  refs = {}
}
#--doc-globalRefs

#--doc-mathSyntax
extension.mathSyntax {
  # The following options control the supported delimiters for inline and display (block)
  # math syntax. Each can be set to one of "tex", "asciimath" or null (disabled).
  dollarInline     = null # Single dollar inline, like Pandoc's tex_math_dollars
  dollarBlock      = null # Double dollar blocks
  singleBackslash  = null # Single backslash `\(inline\)` and `\[display\]`
  doubleBackslash  = null # Double backslash `\\(inline\\)` and `\\[display\\]`
  dollarInlineCode = null # Single dollar at beginning and end of inline code
  dollarFenced     = null # Single dollar for inline math in fenced code blocks
}
#--doc-mathSyntax

#--doc-highlightjs
# Settings for the highlight.js-based syntax highlighter
extension.highlightjs {
  # Preloaded languages. Any language that you want to access via an alias
  # should be listed here.
  preload = [scala, java, json, yaml, sql, ini, diff, bash, xml, markdown]

  # Default language when none is specified. Can be one of the supported languages,
  # an array of languages from which to pick automatically, or null or an empty array
  # for plain text. There are separate defaults for fenced code blocks, indented
  # code blocks and inline code.
  fenced    = ${extension.highlightjs.preload}
  indented  = ${extension.highlightjs.preload}
  inline    = null

  # URIs of CSS files and assorted resources required for the style
  # (relative to webjar:/highlight.js/styles/)
  styleResources = [ github-gist.css ]

  # Language codes that should not be processed by the highlighter
  ignore = []
}
#--doc-highlightjs

#--doc-theme
# Theme-specific settings for the default theme.
theme.default {
  # Settings which are only accessed globally
  global {
    # Synthetic pages to be generated without matching source files.
    # Source URI (relative to site:/), or null to omit a page.
    # If a matching source file exists, it is used instead of generating a page.
    pages {
      toc = "site-contents.md"
      #index = "site-index.md"
      search = "site-search.md"
    }
    # Directory (as URI relative to site:/) where the theme places resources
    resourceDir = "theme"
    # If set to a file name like "index.html", generated links to this name will
    # go to the directory instead
    indexPage = null
    # Search index file that is generated if theme.default.global.pages.search
    # is defined (URI relative to site:/, or null to disable the search index)
    searchIndex = "search-index.js"
    # Array of gitignore-style patterns matching page URIs (relative to site:/)
    # to exclude from the search index
    searchExcludePages = [ ${theme.default.global.pages.search} ]
    # Number of characters per page to use for excerpts in search results
    # (0 to disable excerpts)
    searchExcerptLength = 200
    # Front matter for the generated search page
    searchPageConfig {
      theme.default.template: search
      theme.default.pageNav: false
    }
    #--doc-minify
    minify {
      all = false
      # Minify CSS files with CSSO
      css = ${theme.default.global.minify.all}
      # Minify JS files with Closure Compiler
      js = ${theme.default.global.minify.all}
      # Minify generated HTML files with HtmlCompressor
      html = ${theme.default.global.minify.all}
    }
    #--doc-minify
    #--doc-mathjax
    # Configuration options for MathJax
    mathJax {
      # The config files to preload:
      loadConfig = ["TeX-MML-AM_CHTML-full"]
      # A configuration object to put into the generated HTML files
      inlineConfig = {
        # The default scheme automatically schedules a `Process` command on startup when
        # this option is set. This avoids running any preprocessors that may have been
        # loaded (but are not needed because Ornate creates `script` tags for MathJax's
        # main processing step).
        skipStartupTypeset: true
      }
    }
    #--doc-mathjax
    #--doc-themecolors
    # Configurable colors for the global stylesheet
    color {
      # The main accent color, used for links and active navigation markers
      accent = "rgb(0,120,215)"
      # A light accent color for backgrounds. If unset, use `accent` with 0.15 alpha
      accentBackground = null
      # Text color for page headers and footers
      headerFooter = "white"
      # Background color for page headers and footers
      headerFooterBackground = "#444"
    }
    #--doc-themecolors
    #--doc-themecss
    # Extra CSS settings to append to the generated app.css file
    css  = null
    # A file (relative to the base directory) containing extra CSS settings
    cssFile = null
    #--doc-themecss
  }
  # English-language default strings, referenced from theme.default.strings.
  # Strings are usually parsed as Markdown in the context of the surrounding page.
  en {
    siteNav = null
    pageNav = "On This Page"
    headerLeft = ${meta.siteTitle}
    headerRight = null
    footerLeft = ${meta.copyright}
    footerRight = "Generated with [Ornate](https://github.com/szeiger/ornate)."
    #--doc-navlinks
    navFirst = "![](foundation-icon:previous) First"
    navPrev = "![](foundation-icon:arrow-left) Previous"
    navNext = "![](foundation-icon:arrow-right) Next"
    navLast = "![](foundation-icon:next) Last"
    navToc = "![](foundation-icon:list-thumbnails) Contents"
    navIndex = "![](foundation-icon:list) Index"
    navEdit = "![](foundation-icon:page-edit) Edit Page"
    #--doc-navlinks
    versionNavPrefix = "Version:"
    versionNavLoading = "Loading..."
    tocPage = "# Table of Contents\n\n![](toctree:)"
    indexPage = "# Index\n\n![](index:)"
    indexSymbols = "Symbols"
    searchPlaceholder = "Search"
    searchPage = "# Search\n\nFrom here you can search all pages. Enter the search terms below and click the search button. Note that the search function will search for a combination of *all* search terms."
    noScript = "> {.warning}\n> This page requires JavaScript. Please enable JavaScript in your browser."
    # The searchCount strings are plain text only:
    searchCount0 = "No matching pages found."
    searchCount1 = "Found one matching page:"
    searchCountN = "Found # matching pages:"
  }
  # Localized strings
  strings = ${theme.default.en}
  # Type of the site navigation on the left side ("toctree:" URI or null)
  siteNav = "toctree:maxLevel=1"
  #--doc-multiversion
  # Show multi-version site navigation on the left side below siteNav
  versionNav = false
  # Show multi-version dropdowns for "versions:/" URIs
  versionNavDropdown = true
  # Index page from which to determine the available versions for the multi-version
  # site navigation, relative to the site root's target URI
  versionIndex = "../"
  #--doc-multiversion
  # Show page navigation on the right side (true or false, or null to enable
  # automatically when the page has more than one section)
  pageNav = null
  # Max depth for page navigation (or null to use global.tocMaxLevel)
  pageNavMaxLevel = null
  # Content of navigation bars above and below the content. Possible contents are
  # first, prev, next, last, toc, index, edit. If none of the configured links are
  # available, the bar is not shown.
  topNavBar = [prev, next, edit, toc]
  bottomNavBar = ${theme.default.topNavBar}
  # The target for the "Edit Page" link on all non-synthetic pages. The string `[page]`
  # is replaced by the source page URI relative to global.sourceDir. Set to null to
  # disable "edit page" links.
  editPage = null
  # The template that is used to render pages
  template = default
  #--doc-customlinks
  # A list of extra "link" elements for the HTML header. Each entry is an object whose
  # fields are HTML attributes. The "href" attribute is resolved relative to the current
  # page's "site:" URI, all other attributes are copied verbatim.
  links = []
  #--doc-customlinks
}
#--doc-theme

# Theme-specific settings for the PDF theme.
theme.pdf {
  # Settings which are only accessed globally
  global {
    # File name of the PDF file that is generated under global.targetDir
    targetFile = "output.pdf"
    # Directory relative to global.targetDir where the temporary HTML output is placed
    tempDir = "tmp-html-output"
    # Directory (as URI relative to site:/) where the theme places resources
    resourceDir = "theme"
    # Configuration options for MathJax
    mathJax {
      loadConfig = ["TeX-MML-AM_CHTML-full"]
      inlineConfig = {
        skipStartupTypeset: true
        showProcessingMessages: false
        showMathMenu: false
        showMathMenuMSIE: false
        positionToHash: false
        menuSettings.FastPreview: false
        messageStyle: "none"
      }
    }
    # The wkhtmltopdf executable to launch
    wkhtmltopdf: "wkhtmltopdf"
    pageSize: A4
    dpi: 600
    fontSize: 12 # always in pt
    margin {
      left: 2cm
      right: 2cm
      top: 2cm
      bottom: 2cm
    }
    extraArgs = [
      "--window-status", "done"
      "--no-stop-slow-scripts"
      "--dpi", ${theme.pdf.global.dpi}
      "--image-dpi", ${theme.pdf.global.dpi}
      "--print-media-type"
      "--page-size", ${theme.pdf.global.pageSize}
      "-L", "0"
      "-R", "0"
      "-T", ${theme.pdf.global.margin.top}
      "-B", ${theme.pdf.global.margin.bottom}
    ]
  }
  # English-language default strings, referenced from theme.pdf.strings.
  # Strings are usually parsed as Markdown in the context of the surrounding page.
  en {
    headerLeft = ${meta.siteTitle}
    headerRight = null
    footerLeft = ${meta.copyright}
    footerRight = "Generated with [Ornate](https://github.com/szeiger/ornate)."
    tocPage = "# Table of Contents\n\n![](toctree:)"
  }
  # Localized strings
  strings = ${theme.pdf.en}
  # The template that is used to render pages
  template = default
}

#--doc-clean-theme
# Theme-specific settings for the clean theme
theme.clean.global {
  # Array of gitignore-style patterns matching resources that should not be deleted
  ignore = [".git"]
}
#--doc-clean-theme