Skip to content

5.3 Routing

Christophe edited this page Apr 6, 2017 · 6 revisions

Thanks to his router, you can directly access a note through his URL.

So, if you've a note like /docs/development/atom/plugins.md, you can access this note directly by going to yourwebsite/docs/development/atom/plugins.html.

By adding the .html (or .htm) extension, the router will display its HTML version.

But there is more...

Format parameter

You can also specify a format :

  • add ?format=slides on the querystring to obtain a slideshow
  • or add ?format=pdf for getting the PDF version of the note or just request the pdf file i.e. yourwebsite/docs/development/atom/plugins.pdf (if the file doesn't exists, the pdf version will be created first)

If you don't specify a format, it'll be just like if you've specify ?format=html

Type parameter

When you're displaying a note as a slideshow (so by using ?format=slides), the type of the slideshow will be the one defined in your settings.json file. Two types are supported : remark or reveal.js.

If you wish to force a specific layout, just add the &layout= parameter :