-
Notifications
You must be signed in to change notification settings - Fork 338
Properties
I need to come up with a more consistent set of names for slide and deck level metadata
Page
Variable | Description |
---|---|
page.content |
The rendered content of the page |
page.title |
The title of the page |
page.date |
The date assigned to the page |
page.tags |
The list of tags assigned to the page |
page.file |
The filename with extension .Rmd |
page.link |
The filename with extention .html |
page.filename |
The filename without any extension |
page.raw |
The contents of the .Rmd file |
page.urls.framework |
Relative path to the framework |
page.urls.highlighter |
Relative path to the highlighter |
page.urls.widgets |
Relative path to the widgets folder |
Note: Any custom front matter that you specify will be available under page
. For example, if you specify custom_css: true
in a page's front matter, that value will be available in templates as page.custom_css
Slide
Variable | Description | Type |
---|---|---|
slide.title |
The title of the slide with no markup | Text |
slide.header |
The title of the slide with markup | HTML |
slide.level |
The title header level (h1 - h6) | Number |
slide.content |
The contents of the slide sans header | HTML |
slide.html |
The contents of the slide with header | HTML |
slide.num |
The number of the slide | Number |
slide.id |
The id assigned to the slide | Text |
slide.class |
The class assigned to the slide | List |
slide.bg |
The background assigned to the slide | Text |
slide.block |
The slide block named block | List |
slide.blocks |
The slide blocks which are not named | List |
slide.rendered |
The rendered slide | HTML |
TO DO
-
I should modify the paths variable to
page.urls
so thatpage.url
can be used to refer to the url of the page. Hence,page.urls
will containlib
,framework
,assets
,highlighters
,widgets
etc. -
I should revisit names for layouts. One option is to follow
jekyll
andruhoh
and usedefault.html
,page.html
andpost.html
. Every framework can specify a default layout. This will allow slide generation frameworks to just use the default layout, while blog generation frameworks can use page or post. -
I need to add visual tests for each framework, which would test all features. This would allow me to develop faster without worrying about regressions.