_config.yml

   1
   2 output: web
   3 # this property is useful for conditional filtering of content that is separate from the PDF.
   4
   5 topnav_title: WoltLab Suite 5.3 Documentation
   6 # this appears on the top navigation bar next to the home button
   7
   8 site_title: WoltLab Suite 5.3 Documentation
   9 # this appears in the html browser tab for the site title (seen mostly by search engines, not users)
  10
  11 company_name: WoltLab GmbH
  12 # this appears in the footer
  13
  14 github_editme_path: woltlab/woltlab.github.io/blob/master
  15 # 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.
  16
  17 disqus_shortname:
  18 # if you're using disqus for comments, add the shortname here. if not, leave this value blank.
  19
  20 host: 127.0.0.1
  21 # the preview server used. Leave as is.
  22
  23 port: 4000
  24 # 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.
  25
  26 exclude:
  27   - .idea/
  28   - .gitignore
  29 # these are the files and directories that jekyll will exclude from the build
  30
  31 feedback_subject_line: Jekyll documentation theme
  32
  33 feedback_email: tomjohnson1492@gmail.com
  34 # used as a contact email for the Feedback link in the top navigation bar
  35
  36 # feedback_disable: true
  37 # if you uncomment the previous line, the Feedback link gets removed
  38
  39 # feedback_text: "Need help?"
  40 # if you uncomment the previous line, it changes the Feedback text
  41
  42 # feedback_link: "http://helpy.io/"
  43 # if you uncomment the previous line, it changes where the feedback link points to
  44
  45 highlighter: rouge
  46 # library used for syntax highlighting
  47
  48 markdown: kramdown
  49 kramdown:
  50  input: GFM
  51  auto_ids: true
  52  hard_wrap: false
  53  syntax_highlighter: rouge
  54 # filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways
  55
  56 collections:
  57   tooltips:
  58     output: true
  59 # 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
  60
  61 defaults:
  62   -
  63     scope:
  64       path: ""
  65       type: "pages"
  66     values:
  67       layout: "page"
  68       comments: true
  69       search: true
  70       sidebar: home_sidebar
  71   -
  72     scope:
  73       path: ""
  74       type: "tooltips"
  75     values:
  76       layout: "page"
  77       comments: true
  78       search: true
  79       tooltip: true
  80
  81   -
  82     scope:
  83       path: ""
  84       type: "posts"
  85     values:
  86       layout: "post"
  87       comments: true
  88       search: true
  89       sidebar: home_sidebar
  90
  91 # these are defaults used for the frontmatter for these file types
  92
  93 sidebars:
  94 - sidebar
  95 - other
  96
  97 description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
  98 # the description is used in the feed.xml file
  99
 100 # needed for sitemap.xml file only
 101 url: https://docs.woltlab.com