_config.yml

repository: canardoux/tau_doc
encoding: utf-8

output: web
# this property is useful for conditional filtering of content that is separate from the PDF.

topnav_title: "tau Documentation"
# this appears on the top navigation bar next to the home button

site_title: "The tau Project documentation."
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)

company_name: xyz.canardoux
# this appears in the footer

github_editme_path: canardoux/tau_doc/blob/gh-pages/
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.

# gitlab_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/
# if you're using GitLab, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.

google_analytics: # G-DPDLW922EP # UA-66296557-1
# if you have google-analytics ID, put it in. if not, edit this value to blank.

host: 127.0.0.1
# the preview server used. Leave as is.

port: 4000
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.

exclude:
  - .idea/
  - .gitignore
  - vendor
# these are the files and directories that jekyll will exclude from the build

feedback_subject_line: The tau Project documentation

feedback_email: larpoux@canardoux.xyz
# used as a contact email for the Feedback link in the top navigation bar

# feedback_disable: true
# if you uncomment the previous line, the Feedback link gets removed

# feedback_text: "Need help?"
# if you uncomment the previous line, it changes the Feedback text

# feedback_link: "http://helpy.io/"
# if you uncomment the previous line, it changes where the feedback link points to


FS_VERSION: 1.1.1
TD_VERSION: 3.3.3
ETAU_VERSION: 0.0.14-alpha.1
ETAU_VERSION: 0.0.14-alpha.1

highlighter: rouge
# library used for syntax highlighting

markdown: kramdown
kramdown:
 input: GFM
 auto_ids: true
 hard_wrap: false
 syntax_highlighter: rouge

# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways

collections:
  tooltips:
    output: false
# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true

defaults:
  -
    scope:
      path: ""
      type: "pages"
    values:
      layout: "page"
      comments: true
      # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
      search: true
      sidebar: mydoc_sidebar
      topnav: topnav

  -
    scope:
      path: "pages/fs/fs_api"
      type: "api"
    values:
      layout: "page"
      comments: false
      # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
      search: true
      sidebar: fs_sidebar
      toc: false
      topnav: topnav
      tooltip: true

  -
    scope:
      path: "pages/et/et_api"
      type: "api"
    values:
      layout: "page"
      comments: false
      # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
      search: true
      sidebar: et_sidebar
      toc: false
      topnav: topnav
      tooltip: true

  -
    scope:
      path: "pages/web/web_api"
      type: "api"
    values:
      layout: "page"
      comments: false
      # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
      search: true
      sidebar: web_sidebar
      toc: false
      topnav: topnav
      tooltip: true

  -
    scope:
      path: ""
      type: "tooltips"
    values:
      layout: "page"
      comments: false
      # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
      search: true
      sidebar: td_sidebar
      toc: false
      topnav: topnav
      tooltip: true

  -
    scope:
      path: ""
      type: "posts"
    values:
      layout: "post"
      comments: true
      # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
      search: true
      sidebar: mydoc_sidebar
      topnav: topnav

# these are defaults used for the frontmatter for these file types

sidebars:
- other
- fs_sidebar
- td_sidebar
- et_sidebar
- web_sidebar

description: "This is the documentation of the tau Project."
# the description is used in the feed.xml file

# needed for sitemap.xml file only
url: https://canardoux.github.io/tau_doc
#baseurl: /tau
github: [metadata]