hiro/ablog
1
0
Fork 0
mirror of https://github.com/vale981/ablog synced 2025-03-05 09:11:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.rst

Browse source
This commit is contained in:
Ahmet Bakan 2015-03-01 09:50:39 -08:00
parent 32ff7c433a
commit fd8de49ce2
1 changed files with 14 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.rst
View file

@ -1,24 +1,20 @@
ABlog for Sphinx
================
It's a Blog... It's a Documentation... It's Sphinx with ABlog
ABlog is a Sphinx extension that converts any documentation or personal
website project into a full-fledged blog with:
* `Atom feeds`_, e.g. `ABlog feed`_
* `Archive pages`_, e.g. `ABlog archive`_
* `Blog sidebars`_ with including tag cloud, archive links, etc.
* `Atom feeds`_
* `Archive pages`_
* `Blog sidebars`_
* `Disqus integration`_
* `Font-Awesome integration`_
Looking for an example? Take a look at `ABlog documentation <http://ablog.readthedocs.org>`_
where each manual page and release is a blog post ;)
where each manual and release is a blog post ;)
.. _Atom feeds: http://ablog.readthedocs.org/manual/ablog-configuration-options/#blog-feeds
.. _ABlog feed: http://ablog.readthedocs.org/blog/atom.xml
.. _Archive pages: http://ablog.readthedocs.org/manual/cross-referencing-blog-pages/#archives
.. _ABlog archive: http://ablog.readthedocs.org/blog/
.. _Atom feeds: http://ablog.readthedocs.org/blog/atom.xml
.. _Archive pages: http://ablog.readthedocs.org/blog/
.. _Blog sidebars: http://ablog.readthedocs.org/manual/ablog-configuration-options/#sidebars
.. _Disqus integration: http://ablog.readthedocs.org/manual/ablog-configuration-options/#disqus-integration
.. _Font-Awesome integration: http://ablog.readthedocs.org/manual/ablog-configuration-options/#fa
@ -30,11 +26,11 @@ You can install ABlog using pip_::
pip install -U ablog
This will also install required packages Sphinx_ and Werkzeug_, respectively required
for building your website and generating feeds.
This will install required packages Sphinx_ and Werkzeug_ as well, respectively for
building your website and generating feeds.
If you don't already have a Sphinx project with a nice theme, you might want to
install Alabaster_ to start with a good looking website::
install Alabaster_ too to start with a good looking website::
pip install Alabaster
@ -49,31 +45,28 @@ Getting Started
If you are starting a new project, see `ABlog Quick Start`_ guide.
If you already have a project, enable blogging by editing ``conf.py``
as follows:
If you already have a project, enable blogging by editing ``conf.py`` as follows:
.. code-block:: python
# 1. append ablog to list of extensions
# 1. Append ablog to list of extensions
extensions = [
'...',
'ablog'
]
# 2a. append ABlog templates path to `templates_path`
# 2a. Append ABlog templates path to `templates_path`
import ablog
templates_path.append(ablog.get_html_templates_path())
# 2b. if `templates_path` is not defined before
# 2b. If `templates_path` is not defined before
templates_path = [ablog.get_html_templates_path()]
If you have also installed Alabaster_, see here_ how to configure it.
.. here_: https://github.com/bitprophet/alabaster#installation
.. _ABlog Quick Start: http://ablog.readthedocs.org/manual/ablog-quick-start
.. templates_path: http://sphinx-doc.org/config.html#confval-templates_path
.. here_: https://github.com/bitprophet/alabaster#installation
How it works
------------
@ -84,15 +77,7 @@ You can convert *any page* to a post with the ``post`` directive as follows:
.. post:: Apr 15, 2014
:tags: python, earth, love, peace
:category:
:language: en
:location: Milky Way
:author:
Here Goes Your Post or Page Title
=================================
Followed by an awesome content!
ABlog will catalog all ``.rst`` files (pages) indicated as posts as above,
whithout interfering with Sphinx's operations. Since any page from any folder