|
|
@@ -89,7 +89,116 @@ You can preview the HTML generated files using::
|
|
|
|
|
|
And that is all in a quick way. To learn more, your probably need to know
|
|
|
some Jinja2 and maybe some HTML to get a good looking website. Alas, you can
|
|
|
-use the existing example `blogit-mir` theme to quickly get started.
|
|
|
+use the existing example `blogit-mir` theme to quickly get started. To use this
|
|
|
+theme there is the `quick-start` option, just create a directory where you want
|
|
|
+your files to exist and issue::
|
|
|
+
|
|
|
+ $ blogit --quick-start
|
|
|
+
|
|
|
+This command will create in your directory the following structure::
|
|
|
+
|
|
|
+ .
|
|
|
+ ├── conf.py
|
|
|
+ ├── content
|
|
|
+ │ ├── pages
|
|
|
+ │ │ └── about.md
|
|
|
+ │ └── posts
|
|
|
+ │ ├── 1865-11-26-down-the-rabbit-hole.md
|
|
|
+ │ ├── 1871-03-18-looking-glass-house.md
|
|
|
+ │ ├── 1912-07-24-out-to-sea.md
|
|
|
+ │ ├── 1948-12-12-the-purpose-of-education.md
|
|
|
+ │ ├── 1963-08-28-i-have-a-dream.md
|
|
|
+ │ └── 2014-08-12-the-businessman-and-fisherman.md
|
|
|
+ ├── media
|
|
|
+ │ ├── css
|
|
|
+ │ │ ├── bootstrap.min.css
|
|
|
+ │ │ ├── bootstrap-theme.min.css
|
|
|
+ │ │ ├── print.css
|
|
|
+ │ │ ├── pygments_style.css
|
|
|
+ │ │ ├── site.css
|
|
|
+ │ │ ├── style.css
|
|
|
+ │ │ └── tipsy.css
|
|
|
+ │ ├── img
|
|
|
+ │ │ ├── about.png
|
|
|
+ │ │ ├── body_bg.png
|
|
|
+ │ │ ├── code_top_bg.png
|
|
|
+ │ │ ├── flickr.png
|
|
|
+ │ │ ├── github.png
|
|
|
+ │ │ ├── g+.png
|
|
|
+ │ │ ├── home.png
|
|
|
+ │ │ ├── in.png
|
|
|
+ │ │ ├── noise.png
|
|
|
+ │ │ ├── rss.png
|
|
|
+ │ │ └── twitter.png
|
|
|
+ │ └── js
|
|
|
+ │ ├── bootstrap.min.js
|
|
|
+ │ ├── googlefonts.js
|
|
|
+ │ ├── highlight.pack.js
|
|
|
+ │ ├── jquery.js
|
|
|
+ │ ├── jquery.min.js
|
|
|
+ │ ├── jquery.tipsy.js
|
|
|
+ │ └── scripts.js
|
|
|
+ ├── __pycache__
|
|
|
+ │ └── conf.cpython-35.pyc
|
|
|
+ ├── README.md
|
|
|
+ └── templates
|
|
|
+ ├── about.html
|
|
|
+ ├── archive_index.html
|
|
|
+ ├── atom.xml
|
|
|
+ ├── base.html
|
|
|
+ ├── discuss.html
|
|
|
+ ├── entry.html
|
|
|
+ ├── entry_index.html
|
|
|
+ ├── explorer.html
|
|
|
+ ├── google_analytics.html
|
|
|
+ ├── sidebar.html
|
|
|
+ └── tag_index.html
|
|
|
+
|
|
|
+ 9 directories, 46 files
|
|
|
+
|
|
|
+You can now build the example blog and start the demo webserver in one command::
|
|
|
+
|
|
|
+ $ blogit -bp
|
|
|
+ Rendering website now...
|
|
|
+ entries:
|
|
|
+ posts/1963-08-28-i-have-a-dream.md
|
|
|
+ posts/2014-08-12-the-businessman-and-fisherman.md
|
|
|
+ posts/1948-12-12-the-purpose-of-education.md
|
|
|
+ posts/1912-07-24-out-to-sea.md
|
|
|
+ posts/1865-11-26-down-the-rabbit-hole.md
|
|
|
+ pages/about.md
|
|
|
+ updating tag speeches
|
|
|
+ updating tag fiction
|
|
|
+ updating tag fiction
|
|
|
+ updating tag fables
|
|
|
+ Updating index
|
|
|
+ Updating archive
|
|
|
+ and ready to test at http://127.0.0.1:3030
|
|
|
+ Hit Ctrl+C to exit
|
|
|
+
|
|
|
+The next time you will add a new post **only** that post will be build. Other,
|
|
|
+pages that will be updated are the posts tags, the archive and the main index.
|
|
|
+Everything else remains unchanged. Hence, the speed up in build times.
|
|
|
+
|
|
|
+There is only one caveat for the way blogit does gradual builds. Currently,
|
|
|
+once a post is built it is stored in the file ``content_root/blogit.db`` and
|
|
|
+it is not built again. Future versions of blogit will store also the last
|
|
|
+modification time of the file and will build the file if the change time is
|
|
|
+newer then the one stored in the database.
|
|
|
+
|
|
|
+If you can't wait until than, you can modify the database, or completely remove
|
|
|
+it. Modifying the database is straight forward. It's a simple JSON file. Just
|
|
|
+make sure you don't forget to close curly brackets when you edit the file.
|
|
|
+
|
|
|
+Contributing
|
|
|
+^^^^^^^^^^^^
|
|
|
+
|
|
|
+Bug reports and pull requests are most welcome in https://github.com/oz123/blogit.
|
|
|
+If you happen to create a new theme you can also submit it. Porting jekyll themes
|
|
|
+isn't that hard too.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
|
|
|
.. rubric:: Footnotes
|
|
|
|
Oz N Tiram