1
0
Fork 0
forked from github/pelican
Commit graph

52 commits

Author SHA1 Message Date
Boian Berberov
4f49428961 Documentation changes based on pull request comments.
- Settings -> Template pages: DIRECT_TEMPLATES example
- Creating Themes -> Common variables: authors and tags descriptions
2019-04-04 17:11:58 -06:00
Boian Berberov
86c1db1c63 Adding authors to Common variables
- Adding `authors` to Common variables in the documentation
- Reordering the `authors`, `categories`, `tags` variables in the table
2019-03-26 17:42:59 -06:00
Bryan Brattlof
42c27594ab
Add relative_source_path attribute to content 2019-01-26 18:47:56 -06:00
MinchinWeb
f595741b8e Docs: Reflow to 79 char line limit 2018-11-02 20:53:15 -06:00
Oliver Urs Lenz
576229ad19 allows pages to have draft status, like articles 2018-07-03 12:53:46 +02:00
ix5
69bd9e01b6 Fix documentation for *_SAVE_AS in themes.rst:
Update to current defaults
2017-12-10 07:17:51 +01:00
derwinlu
ec5c77b251 remove PAGES; use pages instead
* remove PAGES from context as pages is available
* add section to FAQ to provide guidance
2015-06-27 19:11:55 +02:00
Jonathan Lange
108b67282a Export hidden pages in context
The `PageGenerator` was building hidden pages, but was not making them
available in the context. This makes it difficult for other plugins to
operate on hidden pages.

This patch updates `PageGenerator` to export the hidden pages it finds
in the context as `hidden_pages`.

It also updates the article generator to export `drafts`.
2015-06-20 11:21:39 +01:00
Alex Chan
f8f89a8476 Fix spelling mistakes in docs 2015-05-24 13:08:23 +01:00
winlu
adc5c4b572 fix broken refs 2015-04-10 09:02:12 +02:00
Justin Mayer
ebf5fca520 Merge pull request #1481 from hrbonz/template_context_docs
Add object details to theme docs
2015-03-24 09:57:32 -07:00
winlu
5432dc04a6 fix double definition of simple theme link to different targets 2015-01-05 12:07:01 +01:00
OGINO Masanori
33994f0024 Add missing names in a list of the feed variables.
Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-11-18 19:48:35 +09:00
gw0 [http://gw.tnode.com/]
85f9608ccb Minor documentation improvements 2014-11-02 15:09:25 -08:00
Stefan 'hr' Berder
5e2e88ca92 add objects details to theme docs 2014-09-28 00:33:29 +08:00
Deniz Turgut
43701cae7c Docs update for *_{previous|next}_page variables 2014-05-27 12:30:42 -04:00
Justin Mayer
86e11c619d Split Getting Started docs into separate sections
The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site
2014-05-12 07:48:37 -07:00
fenekku
f6e27617f8 Add period to period_archives context. Refs #1044.
* Adds period tuple of (year, month, day) matching the time
  period of the current archive. Note that this is done
  to the archive context if period_archives.html doesn't exist.
* Adds tests to verify this.
* Adds documentation in themes.rst about period in period_archives.html.
2014-02-03 20:26:38 -05:00
Justin Mayer
455c159b48 Various fixes to theme documentation 2013-11-07 11:05:22 -08:00
Martin De Wulf
dc0edb2b2b Add doc about use of metadata per article in custom templates 2013-11-07 13:41:19 +01:00
Justin Mayer
f6c9237a01 Enhance and correct documentation 2013-09-23 19:30:51 +02:00
Deniz Turgut
2790446906 adds a 'strftime' jinja fiter that uses LOCALE 2013-04-21 18:00:12 -04:00
John Mastro
f92c800216 Add a period archives feature and brief docs.
Allows users to have per-year, per-month, and per-day archives of posts
automatically generated. The feature is disabled by default; to enable
it a user must supply format strings for a period's respective
`_SAVE_AS` setting.
2013-03-15 17:22:42 -07:00
Alexis Métaireau
fc45d8d791 update the docs regarding all_articles 2013-03-11 23:11:21 -07:00
William Light
e045515b91 add "output_file" Jinja context variable
"output_file" contains the name of the HTML file that pelican is
currently rendering.
2013-03-10 23:53:41 -07:00
W. Trevor King
656b5150ff docs/themes.rst: Document URLWrapper sorting for use in Jinja templates 2013-01-15 22:52:01 -05:00
jawher
c7d87feec3 Reverted FEED_ATOM and FEED_RSS to their original behaviour and added FEED_ALL_ATOM and FEED_ALL_RSS
FEED_(ATOM|RSS) generated feeds include the version in the default language of a translated article,
whereas FEED_ALL(ATOM|RSS) would include *really* all posts, regardless of their language.
2012-11-12 23:01:16 +01:00
Alexis Métaireau
bfc963a065 We pass lists, not dicst! 2012-10-30 18:57:06 +01:00
Alexis Métaireau
93c04cd79f merge with master 2012-10-25 13:20:27 +02:00
jawher
a11726783e TRANSLATION_FEED is now split into TRANSLATION_FEED_ATOM and TRANSLATION_FEED_RSS to match the other feed configuration keys
Incidentally, Pelican can now generate RSS translation feeds.
2012-10-22 22:52:06 +02:00
Justin Mayer
9dcf4e5438 Eliminate extraneous whitespace 2012-10-12 23:01:50 +02:00
Trae Blain
41fdfa63b1 Fixed page_name call to adapt to the link structure provided by the
Settings file. Also updated the documentation accordingly.

Update documentation to cover new page_name behavior

Fixed page_name to adapt to the links provided by the Settings file. Includes documentation updates as well.

Updated terms to maintain better syntax and consistancy

Added docstring to _from_settings() to clarify the get_page_name argument that was added. Explains why/when this argument is used.

Revert contents.py back to commit 2f29c51

Re-added docstring to _get_settings method, but this time not deleting things I shouldn't

Corrected readability change that was altered during revert.
2012-09-04 08:55:43 -05:00
Zoresvit
892761f732 Fixed description of copying themes/static content.
The content from `static` directory is actually copied into `theme/`, not `theme/static/`.
2012-08-16 14:19:10 +03:00
Alexis Metaireau
cf71ed75a4 the repositories are now hosted under 'getpelican' 2012-07-27 00:27:08 +02:00
tBunnyMan
e626f771c4 Add Themes and FAQ documentation on the new FEED_ATOM
Added all the FEED_ATOM variables to _handle_deprecation
Put FEED_ATOM around `if` in notmyidea
2012-07-16 13:47:39 -07:00
Justin Mayer
9ad93d36a0 Convert code in docs to inline literals
Most of the references to code and settings in the docs were wrapped
in single tickmarks (`), while reStructuredText syntax actually calls
for double tickmarks for inline literals, which are normally rendered
as monospaced text with spaces preserved. Converted the relevant
instances to inline literals, along with some other minor fixes.
2012-07-01 10:52:39 -07:00
Justin Mayer
bde06c4011 Improve English documentation with enhanced clarity, grammar, and spelling 2012-03-06 06:13:17 -08:00
Alexis Metaireau
4a6bf81b2e remove skribit support. fixes #154 2011-08-11 23:50:04 +02:00
Alexis Metaireau
6611107e48 little english review on theme extension 2011-07-23 16:06:58 +02:00
Skami18
52df0dc47a Added the documentation for template inheritance
Requires a re-reading by someone speaking English better than me...
2011-07-23 14:53:55 +02:00
Massimo Santini
d7f85712db Added author.html and authors.html templates and modified the docs accordingly 2011-07-16 00:44:49 +02:00
Alexis Daboville
6ba15e6a52 Added a little doc about page.html, fix some typos, follow a single convention for '.' at end of lines. 2011-06-04 15:35:44 +02:00
derdon
befd7098ce typos, grammar mistakes, minor whitespace issues 2011-04-26 02:49:00 +02:00
FELD Boris
6902485c12 Add some docs for skribit integration. 2011-02-22 11:35:06 +01:00
Alexis Metaireau
9f12721895 typo 2011-02-18 12:33:11 +00:00
Laureline Guerin
3f9319d55f some doc about pagination 2011-02-18 11:21:33 +01:00
Alexis Metaireau
2954098004 Update an anchor. 2011-01-20 01:04:54 +01:00
Alexis Metaireau
6b1434f7a7 Add a FAQ. 2011-01-19 16:22:15 +01:00
Alexis Metaireau
b3ca36a8b0 Add references to the simple theme in the documentation. 2011-01-05 14:04:11 +01:00
Alexis Metaireau
3a16dcec8c Add explanations about each template. 2010-12-15 18:13:59 +00:00