Skip to content

Commit 8e3fbe9

Browse files
committedJul 5, 2015
manual & bs3 updates
Signed-off-by: Chris Warrick <kwpolska@gmail.com>
1 parent dea09ef commit 8e3fbe9

File tree

1 file changed

+46
-51
lines changed

1 file changed

+46
-51
lines changed
 

‎stories/manual.txt

+46-51
Original file line numberDiff line numberDiff line change
@@ -492,56 +492,55 @@ to your configuration::
492492
Nikola will also use other metadata fields:
493493

494494
author
495-
Author of the post, will be used in the RSS feed and possibly in the post
496-
display (theme-dependent)
495+
Author of the post, will be used in the RSS feed and possibly in the post
496+
display (theme-dependent)
497497

498498
annotations / noannotations
499-
Override the value of the ``ANNOTATIONS`` option for this specific post or page.
499+
Override the value of the ``ANNOTATIONS`` option for this specific post or page.
500500

501501
category
502-
Like tags, except each post can have only one, and they usually have
503-
more descriptive names.
502+
Like tags, except each post can have only one, and they usually have
503+
more descriptive names.
504504

505505
filters
506-
See the `Post Processing Filters`_ section.
506+
See the `Post Processing Filters`_ section.
507507

508508
hidetitle
509-
Set "True" if you do not want to see the **page** title as a
510-
heading of the output html file (does not work for posts).
509+
Set "True" if you do not want to see the **page** title as a
510+
heading of the output html file (does not work for posts).
511511

512512
nocomments
513-
Set to "True" to disable comments. Example::
513+
Set to "True" to disable comments. Example::
514514

515-
.. nocomments: True
515+
.. nocomments: True
516516

517517
password
518-
The post will be encrypted and invisible until the reader enters the password.
519-
Also, the post's sourcecode will not be available.
518+
The post will be encrypted and invisible until the reader enters the password.
519+
Also, the post's sourcecode will not be available.
520520

521-
WARNING: **DO NOT** use for real confidential data. The algorithm used (RC4) is insecure. The implementation may also be easily brute-forced. Please consider using something else if you need *real* encryption!
521+
WARNING: **DO NOT** use for real confidential data. The algorithm used (RC4) is insecure. The implementation may also be easily brute-forced. Please consider using something else if you need *real* encryption!
522522

523-
More information: `Issue #1547 <https://github.com/getnikola/nikola/issues/1547>`_
523+
More information: `Issue #1547 <https://github.com/getnikola/nikola/issues/1547>`_
524524

525525
previewimage
526-
Designate a preview or other representative image path relative to BASE_URL
527-
for use with Open Graph for posts. Adds the image when sharing on social
528-
media and many other uses.
526+
Designate a preview or other representative image path relative to BASE_URL
527+
for use with Open Graph for posts. Adds the image when sharing on social
528+
media and many other uses. ::
529529

530-
.. previewimage: images/looks_great_on_facebook.png
530+
.. previewimage: images/looks_great_on_facebook.png
531531

532-
The image can be of any size and dimension (services will crop and adapt)
533-
but should less than 1 MB and be larger than 300x300 (ideally 600x600).
532+
The image can be of any size and dimension (services will crop and adapt)
533+
but should less than 1 MB and be larger than 300x300 (ideally 600x600).
534534

535535
template
536-
Will change the template used to render this page/post specific page. Example::
536+
Change the template used to render this page/post specific page. That
537+
template needs to either be part of the theme, or be placed in a
538+
``templates/`` folder inside your site. ::
537539

538-
.. template: story.tmpl
540+
.. template: story.tmpl
539541

540-
That template needs to either be part of the theme, or be placed in a ``templates/``
541-
folder inside your site.
542-
543-
enclosure
544-
Add an enclosure to this post when it's used in RSS. See `more information about enclosures <http://en.wikipedia.org/wiki/RSS_enclosure>`__
542+
enclosure
543+
Add an enclosure to this post when it's used in RSS. See `more information about enclosures <http://en.wikipedia.org/wiki/RSS_enclosure>`__
545544

546545
.. note:: The Two-File Format
547546

@@ -556,11 +555,11 @@ to your configuration::
556555

557556
However, starting with Nikola v7, you can now use ``.meta`` files and put
558557
all metadata you want, complete with the explanations — they look just like
559-
the beginning of our reST files.
558+
the beginning of our reST files. ::
560559

561-
.. title: How to make money
562-
.. slug: how-to-make-money
563-
.. date: 2012-09-15 19:52:05 UTC
560+
.. title: How to make money
561+
.. slug: how-to-make-money
562+
.. date: 2012-09-15 19:52:05 UTC
564563

565564
Both file formats are supported; however, the new format is preferred, if
566565
possible.
@@ -797,6 +796,8 @@ types affect the look of your posts, by adding a ``post-YOURINPUTHERE``
797796
CSS class to the post. Each post can have one and exactly one type. Nikola
798797
styles the following types in the default themes:
799798

799+
.. class:: table table-bordered
800+
800801
+-----------------+----------------------------+------------------+
801802
| Name(s) | Description | Styling |
802803
+=================+============================+==================+
@@ -976,13 +977,13 @@ You surely want to edit these options::
976977
Some options are demarked with a (translatable) comment above or right next to
977978
them. For those options, two types of values can be provided:
978979

979-
* a string, which will be used for all languages
980-
* a dict of language-value pairs, to have different values in each language
980+
* a string, which will be used for all languages
981+
* a dict of language-value pairs, to have different values in each language
981982

982983
.. note:: It is possible to load the configuration from another file by specifying
983984
``--conf=path/to/other.file`` on Nikola's command line. For example, to
984-
build your blog using the configuration file ``configurations/test.config``,
985-
you have to execute ``nikola build --conf=configurations/test.config``.
985+
build your blog using the configuration file ``configurations/test.conf.py``,
986+
you have to execute ``nikola build --conf=configurations/test.conf.py``.
986987

987988
Customizing Your Site
988989
---------------------
@@ -1038,20 +1039,16 @@ Navigation Links
10381039

10391040
.. note::
10401041

1041-
Support for submenus is theme-dependent. Only one level of
1042-
submenus is supported.
1043-
1044-
.. note::
1045-
1046-
Some themes, including the default Bootstrap 3 theme, may
1047-
present issues if the menu is too large. (in ``bootstrap3``, the
1048-
navbar can grow too large and cover contents.)
1042+
1. Support for submenus is theme-dependent. Only one level of
1043+
submenus is supported.
10491044

1050-
.. note::
1045+
2. Some themes, including the default Bootstrap 3 theme, may
1046+
present issues if the menu is too large. (in ``bootstrap3``, the
1047+
navbar can grow too large and cover contents.)
10511048

1052-
If you link to directories, make sure to follow ``STRIP_INDEXES``. If
1053-
it’s set to ``True``, end your links with a ``/``, otherwise end them
1054-
with ``/index.html`` — or else they won’t be hilighted when active.
1049+
3. If you link to directories, make sure to follow ``STRIP_INDEXES``. If
1050+
it’s set to ``True``, end your links with a ``/``, otherwise end them
1051+
with ``/index.html`` — or else they won’t be hilighted when active.
10551052

10561053
The ``SEARCH_FORM`` option contains the HTML code for a search form based on
10571054
duckduckgo.com which should always work, but feel free to change it to
@@ -1138,8 +1135,8 @@ with files Nikola generates (it will give an error).
11381135

11391136
.. admonition:: Important
11401137

1141-
Don't put any files manually in ``output/``. Ever. Really. Maybe someday Nikola
1142-
will just wipe ``output/`` and then you will be sorry. So, please don't do that.
1138+
Don't put any files manually in ``output/``. Ever. Really.
1139+
Maybe someday Nikola will just wipe ``output/`` (when you run ``nikola check -f --clean-files``) and then you will be sorry. So, please don't do that.
11431140

11441141
If you want to copy more than one folder of static files into ``output`` you can
11451142
change the FILES_FOLDERS option::
@@ -1541,7 +1538,6 @@ like this:
15411538

15421539
.. code:: python
15431540

1544-
"""
15451541
MATHJAX_CONFIG = """
15461542
<script type="text/x-mathjax-config">
15471543
MathJax.Hub.Config({
@@ -1556,7 +1552,6 @@ like this:
15561552
}
15571553
});
15581554
</script>
1559-
"""
15601555

15611556
Inline mathematics are produced using the reST `math` **role** or the ``\(…\)`` delimiters:
15621557

0 commit comments

Comments
 (0)
Please sign in to comment.