Skip to content

Latest commit

 

History

History
executable file
·
18 lines (14 loc) · 1.54 KB

config_notes.md

File metadata and controls

executable file
·
18 lines (14 loc) · 1.54 KB
nav_exclude
true

[https://pmarsceill.github.io/just-the-docs/](Guide for configuring "Just the Docs" theme)

JB notes

  • YAML header to exclude a file from naviation, assign navigation title, set nav menu order: nav_exclude: true
  • added /sass/overrides.scss to create formatting for Warning, Info boxes, following instructions at just-the-docs/just-the-docs#171
  • added to /sass/overrides.scss to force child pages to always display in navigation menu (see just-the-docs/just-the-docs#245
  • location of files within directory structure does not seem to matter. Site navigation is based on nav_order, title, has_children, and parent parameters in YAML headers for each page
  • _config.yml points to source for Jekyll theme. Not necessary (though maybe desirable) to recreate the entire theme in each repository. To override parts of the theme, add alternative versions of desired files in the local repository (e.g. /sass/overrides.scss)
  • Added local _layouts/default.html to get rid of footer promoting Just the Docs theme
  • Links in the footer_content section of _config.yml should be in html format (not markdown). Entire footer is encolsed in quotation marks; quotation marks in html anchors must be escaped with \

Questions about RC workshop template

  • Where to put copyright info? "footer_content" in _config.yml appears at very bottom of each page (often requires scrolling). If it should always be visible we could display at bottom of left panel by changing _layouts/default.html