aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2020-05-07 01:48:11 +0000
committerEgor Tensin <Egor.Tensin@gmail.com>2020-05-07 01:48:11 +0000
commitadb9b3fe169a92ea2da7b8c804c8b91f966c21a4 (patch)
treefe340f4de0afa6763e220194d2e6bea3366b4c71 /README.md
parentbind-mounts: rename the file (diff)
downloadjekyll-theme-adb9b3fe169a92ea2da7b8c804c8b91f966c21a4.tar.gz
jekyll-theme-adb9b3fe169a92ea2da7b8c804c8b91f966c21a4.zip
remove everything except Jekyll theme stuff
I tagged the previous commit to explain what's going on.
Diffstat (limited to '')
-rw-r--r--README.md111
1 files changed, 0 insertions, 111 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 68da3b5..0000000
--- a/README.md
+++ /dev/null
@@ -1,111 +0,0 @@
-Egor's blog
-===========
-
-Egor's blog on programming.
-Hosted on [GitHub Pages] at https://egor-tensin.github.io/blog/.
-
-[GitHub Pages]: https://pages.github.com
-
-Prerequisites
--------------
-
-[Jekyll] is used to build a set of static HTML pages from a collection of
-templates and resources.
-[Bundler] is used to manage project's dependencies.
-Make sure you have the `bundler` gem installed; project dependencies can then
-be installed by executing
-
- bundle install
-
-in the project's root directory.
-
-[Jekyll]: https://jekyllrb.com/
-[Bundler]: http://bundler.io/
-
-Usage
------
-
-To run a local web server, execute
-
- bundle exec jekyll serve --watch --drafts --config _config.yml,_config_dev.yml
-
-in the project's root directory.
-You can then review your changes at http://localhost:4000/.
-
-If you can't get Jekyll to properly `--watch` for file modifications on
-Windows, try adding `--force_polling` to `jekyll`s options:
-
- bundle exec jekyll serve --watch --force_polling --drafts --config _config.yml,_config_dev.yml
-
-It might still not work though, but you can always re-run `jekyll` manually.
-
-Note that `_config_dev.yml` is included to rewrite some of the `site` fields
-from `_config.yml` during development.
-In particular, it
-
-* sets `minified_externals` to `false` so that the properly formatted versions
-of external CSS stylesheets and JavaScript files are included instead of the
-`min`ified versions,
-* sets `include_comments` to `false` to exclude the Disqus comments section
-from the posts,
-* sets `baseurl` to an empty string so that the website can be accessed from
-local web server's root directory (i.e. from http://localhost:4000/ instead of
-http://localhost:4000/blog/).
-
-### Access via file://
-
-Jekyll doesn't provide native support for generating a static website which can
-be browsed without running an instance of Jekyll's web server.
-One easy workaround is to `wget` the website and convert the links:
-
- wget --convert-links --recursive http://localhost:4000/
-
-### Typesetting math
-
-[MathJax] can be used to typeset mathematics using LaTeX.
-To use MathJax, set `mathjax` to `true` in page's front matter.
-Then you can do things like this:
-
-```
-This is an inline formula: $$y = kx + b$$.
-This is a formula in a separate block:
-
-$$
-y = kx + b
-$$
-```
-
-[MathJax]: https://www.mathjax.org/
-
-#### GitHub workarounds
-
-MathJax version 3 is used, which is unsupported by Kramdown (which produces
-`<script type="math/tex; ..."` tags, suitable only for MathJax 2.
-This is why `math_engine` is set to `null` in _config.yml, making Kramdown
-output block formulas wrapped in `$$` and inline formulas in `$` respectively
-([inside `<span class="kdmath">` elements][kramdown issue]).
-Because if this, MathJax is additionally customized to recognize `$` as an
-inline formula delimiter in _includes/common/mathjax.html.
-
-GitHub Pages [helpfully overrides] the `math_engine` setting in your
-_config.yml, hardcoding it to `mathjax` instead of `null` (there's a related
-[pull request]).
-I couldn't find a better way than to override the setting in the markdown
-document itself using
-
- {::options math_engine="+nil+" /}
-
-[kramdown issue]: https://github.com/gettalong/kramdown/issues/342
-[helpfully overrides]: https://help.github.com/en/articles/configuring-jekyll
-[pull request]: https://github.com/github/pages-gem/pull/644
-
-License
--------
-
-Distributed under the MIT License.
-See [LICENSE.txt] for details.
-
-This website is build upon the Twitter Bootstrap framework, which is also MIT
-Licensed and copyright 2015 Twitter.
-
-[LICENSE.txt]: LICENSE.txt