mirror of
https://github.com/vale981/ablog
synced 2025-03-05 17:21:38 -05:00
Revised index/readme content.
This commit is contained in:
parent
5b416670a6
commit
3db64da512
2 changed files with 22 additions and 24 deletions
24
README.rst
24
README.rst
|
@ -19,6 +19,8 @@ where each manual and release is a blog post ;)
|
||||||
.. _Disqus integration: http://ablog.readthedocs.org/manual/ablog-configuration-options/#disqus-integration
|
.. _Disqus integration: http://ablog.readthedocs.org/manual/ablog-configuration-options/#disqus-integration
|
||||||
.. _Font-Awesome integration: http://ablog.readthedocs.org/manual/ablog-configuration-options/#fa
|
.. _Font-Awesome integration: http://ablog.readthedocs.org/manual/ablog-configuration-options/#fa
|
||||||
|
|
||||||
|
.. _installation:
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
@ -50,25 +52,24 @@ If you already have a project, enable blogging by making following changes in ``
|
||||||
'ablog'
|
'ablog'
|
||||||
]
|
]
|
||||||
|
|
||||||
# 2a. Append templates path to `templates_path`
|
# 2. Append templates path to `ablog.templates_path()`
|
||||||
import ablog
|
import ablog
|
||||||
|
|
||||||
|
# 2a. `templates_path` exists
|
||||||
templates_path.append(ablog.get_html_templates_path())
|
templates_path.append(ablog.get_html_templates_path())
|
||||||
|
|
||||||
# 2b. If `templates_path` is not defined before
|
# 2b. `templates_path` is not defined before
|
||||||
templates_path = [ablog.get_html_templates_path()]
|
templates_path = [ablog.get_html_templates_path()]
|
||||||
|
|
||||||
If you also installed Alabaster_, see how to configure it here_.
|
|
||||||
|
|
||||||
.. _ABlog Quick Start: http://ablog.readthedocs.org/manual/ablog-quick-start
|
.. _ABlog Quick Start: http://ablog.readthedocs.org/manual/ablog-quick-start
|
||||||
.. _here: https://github.com/bitprophet/alabaster#installation
|
|
||||||
|
|
||||||
How it works
|
How it works
|
||||||
------------
|
------------
|
||||||
|
|
||||||
If you are new to Sphinx_ and reStructuredText markup language,
|
If you are new to Sphinx_ and reStructuredText markup language,
|
||||||
you might find `reStructuredText Primer`_ useful. Once you have
|
you might find `reStructuredText Primer`_ useful. Once you have
|
||||||
some content (in ``.rst`` files), you can post *any page* using
|
content (in ``.rst`` files), you can post *any page* using the
|
||||||
the ``post`` directive as follows:
|
``post`` directive as follows:
|
||||||
|
|
||||||
.. code-block:: rst
|
.. code-block:: rst
|
||||||
|
|
||||||
|
@ -79,9 +80,8 @@ the ``post`` directive as follows:
|
||||||
:location: SF
|
:location: SF
|
||||||
:language: en
|
:language: en
|
||||||
|
|
||||||
ABlog will index all files posted as above. When building HTML pages,
|
ABlog will index all files posted as above and list them in archives and feeds
|
||||||
it will create archives and feeds that list these posts as
|
specified in ``:tag:``, ``:category:``, etc. options.
|
||||||
specified by ``:tag:``, ``:category:``, etc. options.
|
|
||||||
|
|
||||||
You can also include a list of posts using ``postlist`` directive:
|
You can also include a list of posts using ``postlist`` directive:
|
||||||
|
|
||||||
|
@ -91,8 +91,8 @@ You can also include a list of posts using ``postlist`` directive:
|
||||||
:category: Manual
|
:category: Manual
|
||||||
:reverse:
|
:reverse:
|
||||||
|
|
||||||
For ABlog documentation, this converts to the following list of links that you
|
For ABlog documentation, this converts to the following where you
|
||||||
can follow to learn more about configuring and using ABlog:
|
can find more about configuring and using ABlog:
|
||||||
|
|
||||||
* `Posting and Listing <http://ablog.readthedocs.org/manual/posting-and-listing/>`_
|
* `Posting and Listing <http://ablog.readthedocs.org/manual/posting-and-listing/>`_
|
||||||
* `ABlog Configuration Options <http://ablog.readthedocs.org/manual/ablog-configuration-options/>`_
|
* `ABlog Configuration Options <http://ablog.readthedocs.org/manual/ablog-configuration-options/>`_
|
||||||
|
|
|
@ -52,25 +52,24 @@ If you already have a project, enable blogging by making following changes in ``
|
||||||
'ablog'
|
'ablog'
|
||||||
]
|
]
|
||||||
|
|
||||||
# 2a. Append templates path to `templates_path`
|
# 2. Append templates path to `ablog.templates_path()`
|
||||||
import ablog
|
import ablog
|
||||||
|
|
||||||
|
# 2a. `templates_path` exists
|
||||||
templates_path.append(ablog.get_html_templates_path())
|
templates_path.append(ablog.get_html_templates_path())
|
||||||
|
|
||||||
# 2b. If `templates_path` is not defined before
|
# 2b. `templates_path` is not defined before
|
||||||
templates_path = [ablog.get_html_templates_path()]
|
templates_path = [ablog.get_html_templates_path()]
|
||||||
|
|
||||||
If you also installed Alabaster_, see how to configure it here_.
|
|
||||||
|
|
||||||
.. _ABlog Quick Start: http://ablog.readthedocs.org/manual/ablog-quick-start
|
.. _ABlog Quick Start: http://ablog.readthedocs.org/manual/ablog-quick-start
|
||||||
.. _here: https://github.com/bitprophet/alabaster#installation
|
|
||||||
|
|
||||||
How it works
|
How it works
|
||||||
------------
|
------------
|
||||||
|
|
||||||
If you are new to Sphinx_ and reStructuredText markup language,
|
If you are new to Sphinx_ and reStructuredText markup language,
|
||||||
you might find `reStructuredText Primer`_ useful. Once you have
|
you might find `reStructuredText Primer`_ useful. Once you have
|
||||||
some content (in ``.rst`` files), you can post *any page* using
|
content (in ``.rst`` files), you can post *any page* using the
|
||||||
the ``post`` directive as follows:
|
``post`` directive as follows:
|
||||||
|
|
||||||
.. code-block:: rst
|
.. code-block:: rst
|
||||||
|
|
||||||
|
@ -81,9 +80,8 @@ the ``post`` directive as follows:
|
||||||
:location: SF
|
:location: SF
|
||||||
:language: en
|
:language: en
|
||||||
|
|
||||||
ABlog will index all files posted as above. When building HTML pages,
|
ABlog will index all files posted as above and list them in archives and feeds
|
||||||
it will create archives and feeds that list these posts as
|
specified in ``:tag:``, ``:category:``, etc. options.
|
||||||
specified by ``:tag:``, ``:category:``, etc. options.
|
|
||||||
|
|
||||||
You can also include a list of posts using ``postlist`` directive:
|
You can also include a list of posts using ``postlist`` directive:
|
||||||
|
|
||||||
|
@ -93,8 +91,8 @@ You can also include a list of posts using ``postlist`` directive:
|
||||||
:category: Manual
|
:category: Manual
|
||||||
:reverse:
|
:reverse:
|
||||||
|
|
||||||
For ABlog documentation, this converts to the following list of links that you
|
For ABlog documentation, this converts to the following where you
|
||||||
can follow to learn more about configuring and using ABlog:
|
can find more about configuring and using ABlog:
|
||||||
|
|
||||||
* `Posting and Listing <http://ablog.readthedocs.org/manual/posting-and-listing/>`_
|
* `Posting and Listing <http://ablog.readthedocs.org/manual/posting-and-listing/>`_
|
||||||
* `ABlog Configuration Options <http://ablog.readthedocs.org/manual/ablog-configuration-options/>`_
|
* `ABlog Configuration Options <http://ablog.readthedocs.org/manual/ablog-configuration-options/>`_
|
||||||
|
|
Loading…
Add table
Reference in a new issue