Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.35 KB

faq.md

File metadata and controls

60 lines (41 loc) · 2.35 KB
Raw
Error in user YAML: (<unknown>): did not find expected key while parsing a block mapping at line 1 column 1
---
"layout": "page",
"title": "Introduction",
"uses": [ { "uri": "navigation.md" } ],
"permalink": true
---

FAQ

Pages

Can we organize markdown files in subdirectories ?

Yes, starting with version 0.4.0 organization of markdown files in subdirectories 'docs/*.md' with extension 'md' under 'docs' folder is possible. With that feature comes the data entry ${data.base}, which is holding the relative path from the current markdown file to the 'docs' folder and can be used in template header sections.

Changing "math" setting in frontmatter section has no visual effect on math rendering.

Hmm, you need to ...

  1. add or change "math":true/false setting in the frontmatter section of your markdown document.
  2. activate (set focus away to) any other editor window (preview window works perfect here).
  3. reactivate (set focus back to) your markdown document.
  4. make any modification (a simple keystroke should work) and see change in math rendering.

Styles

Where are the style sheets ?

The CSS styles are defined in the file /docs/theme/styles.css. They are referenced by the templates in file /docs/theme/template.js.

Can we change the styles ?

Yes. Change them in file /docs/theme/styles.css or rename it or use multiple CSS files. You only need to reference them from the templates in /docs/theme/template.js.

Templates

Where are the templates ?

The templates are defined in file /docs/theme/template.js. They are basically delivered by simple JavaScript functions returning template literals. Those recieve extended versions of the frontmatter metadata.

Can we change the templates ?

Yes, of course. New themes are generated exactly by that. So go on and do it.

Are other template engines supported ?

No sorry, it's due to minimalism paradigma.

Deployment

Is it possible to deploy to other hosting platforms ?

Yes, it should be easy in principle. Nothing done here yet.