AGENTS.md
Build / preview
Jekyll 4.4.1 is installed against Homebrew’s Ruby, which is not on PATH
(the system ruby is 2.6 and there is no Gemfile):
/opt/homebrew/lib/ruby/gems/*/bin/jekyll build # -> _site/
/opt/homebrew/lib/ruby/gems/*/bin/jekyll serve # http://localhost:4000
The pre-existing Conflict: ... the-productive-programmer-on-windows.html
warning is harmless.
Gruntfile.js compiles less/ -> css/argan-blog{,.min}.css and minifies
js/hux-blog.js. Edit the .less/.js sources, not the generated CSS:
npm install && npx grunt # or `npx grunt watch`
Layout
_posts/— blog posts,layout: post, permalink/:title.htmlslides/— reveal.js decks,layout: slides(or set in front matter), URL/slides/:name.html, indexed byslides.html(/slides/)_includes/rich-content.html— Mermaid + KaTeX loaders, shared by_includes/head.htmland_layouts/slides.html. Both renderers are lazy: they only fetch their bundle if the page actually contains a diagram/formula, and they only look inside.post-containerand.reveal .slides._includes/analytics.html— GA + Baidu Tongji, shared byfooter.htmland_layouts/slides.html
Writing a deck
Decks are ordinary Markdown; kramdown renders the file and _layouts/slides.html
splits the HTML on every <hr> into reveal.js <section>s.
- Create
slides/my-talk.mdwithlayout: slidesandpermalink: /slides/my-talk.htmlin the front matter. - Separate slides with
---and always leave a blank line before it, otherwise Markdown reads it as a setext<h2>underline and the slide is not split. <!-- v -->inside a slide creates vertical (nested) sub-slides.<!-- .slide: data-background="#1c1f26" -->puts reveal.js attributes on the current<section>.{: .fragments}on a list reveals it one item at a time;{: .fragment}reveals any single element.- Speaker notes:
<aside class="notes" markdown="1">...</aside>, shown withS. - Export: append
?print-pdfand print from the browser.
slides/reveal-demo.md is a live demo of all of the above.
