From e726014585409acacef2e79a8d83a55a9e47ecb6 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Mon, 31 May 2021 16:10:50 +0300 Subject: add more examples, update README --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9609954..5afec0c 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ My [Jekyll] theme. I use it for [egor-tensin.github.io], [blog], [sorting-algorithms]. [Jekyll]: https://jekyllrb.com/ -[egor-tensin.github.io]: https://github.com/egor-tensin/egor-tensin.github.io -[blog]: https://github.com/egor-tensin/blog/tree/gh-pages -[sorting-algorithms]: https://github.com/egor-tensin/sorting-algorithms/tree/gh-pages +[egor-tensin.github.io]: https://egor-tensin.github.io/ +[blog]: https://egor-tensin.github.io/blog/ +[sorting-algorithms]: https://egor-tensin.github.io/sorting-algorithms/ Preview ------- @@ -93,10 +93,12 @@ Simply including categories/categories.html should do the job. ### Code snippets -See [Test post 3] for an example of how to conveniently embed snippets in your -pages. +See [this post][snippets] for an example of how to conveniently embed code +snippets in your pages. Basically, you need to put something like this in the front matter: +[snippets]: _posts/2021-04-09-snippets.md + ``` snippets_root_directory: snippets snippets_language: c++ @@ -109,8 +111,6 @@ snippets: - world.cpp ``` -[Test post 3]: _posts/2021-04-09-test-post3.md - And then you can just format an entire section of snippets using a single `include`: @@ -120,6 +120,11 @@ And then you can just format an entire section of snippets using a single The line above would output both hello.hpp and hello.cpp to the page. +Code snippets can be hidden in collapsible panels. +See [this post][collapsible] for an example. + +[collapsible]: _posts/2021-04-10-collapsible.md + ### Typesetting math [MathJax] can be used to typeset mathematics using LaTeX. @@ -140,6 +145,10 @@ $$ Behind the scenes, Kramdown transforms these to `\(...\)` and `\[...\]` sequences, to be processed by MathJax. +See [this post][mathjax post] for a usage example. + +[mathjax post]: _posts/2021-04-08-mathjax.md + History ------- -- cgit v1.2.3