Book-like template for Thibaut Lienart's static web-site generator Franklin.jl.
It currently has the following features:
- Provides a menu bar with a table of contents for a given collection of pages (as listed in the variable
menu, in config.md); - Navigation links on each page;
- Automatic numbering of some or all pages, as desired;
- Pages generated in several different formats:
- Franklin.jl's native markdown flavor;
- Julia Markdown (
.jmdfiles) executed by Weave.jl itself. - Literate.jl's Markdown executed by Literate.jl itself.
- Pure julia scripts (with Markdown comments) executed by either Literate.jl or Weave.jl.
- Jupyter notebooks converted to Franklin's markdown with Weave.jl.
- All execution/rendering generated automatically, based on the folder they belong to (whether
pages/,src/weave/,src/literate/orsrc/jupyter, with the files in the latter three folders being rendered to markdown files inpages/weaved/,pages/literated/, andpages/jupytered, respectively). - Whatever the source file, a Jupyter notebook is generated for each page and stored in the folder
generated/. - Badge links included on each page to either download the associated jupyter notebook, or view it in NBViewer, or launch it in Binder, or download its source.
- Appealing visual display based on Rik Huijzer's CSS used in Books.jl.
This is an off-spring of the draft template in tlienart/booksjl-franklin, with many extra goodies.
⚠️ WARNING: This template is under active development and in alpha stage, with the code being optimized, bugs being addressed, and more tools/configurations being implemented. If you are interested, feel free to use it and report eventual problems. Contributions are also welcome.