Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 3.14 KB

index.md

File metadata and controls

75 lines (55 loc) · 3.14 KB

@def hascode = true

Building static websites in Julia

\blurb{Franklin is a simple, customisable static site generator oriented towards technical blogging and light, fast-loading pages.}

Key features

click on the '✓' sign to know more

@@flist

  • \goto{/syntax/markdown/}Augmented markdown allowing definition of LaTeX-like commands,
  • \goto{/syntax/divs-commands/} Easy inclusion of user-defined div-blocks,
  • \goto{/syntax/divs-commands/} Maths rendered via KaTeX, code via highlight.js both can be pre-rendered,
  • \goto{/code/} Can live-evaluate Julia code blocks,
  • \goto{/workflow/#creating_your_website} Live preview of modifications,
  • \goto{/workflow/#optimisation_step} Simple optimisation step to compress and pre-render the website,
  • \goto{/workflow/#publication_step} Simple publication step to deploy the website,
  • \goto{/code/literate/} Straightforward integration with Literate.jl. @@

\note{If you already have experience with Franklin and just want to keep an eye on (new) tips and tricks, have a look at the short demos}

Quick start

To install Franklin with Julia ≥ 1.3,

(v1.6) pkg> add Franklin

You can then just try it out:

julia> using Franklin
julia> newsite("mySite", template="pure-sm")
✓ Website folder generated at "mySite" (now the current directory).
→ Use serve() from Franklin to see the website in your browser.

julia> serve()
→ Initial full pass...
→ Starting the server...
✓ LiveServer listening on http://localhost:8000/ ...
  (use CTRL+C to shut down)

If you navigate to that URL in your browser, you will see the website. If you then open index.md in an editor and modify it at will, the changes will be live rendered in your browser. You can also inspect the file menu1.md which offers more examples of what Franklin can do.

Installing optional extras

Franklin allows a post-processing step to compress HTML and CSS and pre-render code blocks and math environments. This requires a couple of dependencies: @@tlist

  • python3 for the minification of the site,
  • node.js for the pre-rendering of KaTeX and code highlighting. @@ You will then need to install highlight.js, which you should do from Julia using the NodeJS.jl package:
julia> using NodeJS
julia> run(`sudo $(npm_cmd()) install highlight.js`)

Note: a key advantage of using NodeJS for this instead of using npm yourself is that it puts the libraries in the "right place" for Julia to find them.

Assuming you have python3, Franklin will try to install the python package css_html_js_minify if via pip3.

\note{ You don't have to install these libraries and you can safely ignore any message suggesting you install those. Also note that if you do want this but it doesn't work locally due to some node weirdness or related, things will likely still work if you use GitHub to deploy. }