aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 12 insertions, 27 deletions
diff --git a/README.md b/README.md
index 7c97992..94578f4 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,8 @@ This is my website hosted on [GitHub Pages] at https://egor-tensin.github.io/.
[GitHub Pages]: https://pages.github.com
-Prerequisites
--------------
+Development
+-----------
[Jekyll] is used to build a set of static HTML pages from a collection of
templates and resources.
@@ -18,41 +18,29 @@ be installed by executing
in the project's root directory.
-[Jekyll]: https://jekyllrb.com/
-[Bundler]: http://bundler.io/
-
-Usage
------
-
-To run a local web server, execute
+To run a local web server, run
bundle exec jekyll serve --watch --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:
+Or you can use [jekyll-docker] to set up a development environment in Docker
+and not bother with installing everything locally.
- bundle exec jekyll serve --watch --force_polling --config _config.yml,_config_dev.yml
+[jekyll-theme] is used as a remote Jekyll theme.
-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.
+[Jekyll]: https://jekyllrb.com/
+[Bundler]: http://bundler.io/
+[jekyll-docker]: https://github.com/egor-tensin/jekyll-docker
+[jekyll-theme]: https://github.com/egor-tensin/jekyll-theme
-### Accessing via file://
+### 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/
+ wget --no-verbose --recursive --convert-links --adjust-extension -- http://localhost:4000/
License
-------
@@ -60,7 +48,4 @@ 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