Commit graph

40 commits

Author SHA1 Message Date
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
Ondrej Grover
6703950abe enable writing of only selected output paths
- add WRITE_SELECTED setting
- add --write-selected commandline option
2014-04-17 19:36:18 +02:00
Ondrej Grover
fd77926700 Cache content to speed up reading. Fixes #224.
Cache read content so that it doesn't have to be read next time if its
source has not been modified.
2014-04-15 08:57:38 -04:00
Justin Mayer
ae2afa27fc Clarify FAQ entry re: need to install Markdown
Folks keep running into this error, which probably signals a need to
change this behavior. After all, it wouldn't be hard for us to detect
what's going on and provide a better error message, such as: "It looks
like you're trying to process Markdown, but the Markdown library is not
currently installed. Please install the Python-Markdown library via 'pip
install markdown'."

Until we implement something akin to the above, this should serve as a
slightly-improved FAQ entry in the interim.
2013-10-19 17:20:13 +02:00
Justin Mayer
f6c9237a01 Enhance and correct documentation 2013-09-23 19:30:51 +02:00
Alexis Métaireau
22da74211d Fix a broken link 2013-09-17 17:32:08 +02:00
Talha Mansoor
bc26cde436 Add details on how to use Pelican for non-blog static sites
This question comes up on IRC quite frequently.
2013-09-08 23:05:52 +02:00
karl
a4ce664f17 fixing the inline code markup 2013-08-03 22:31:54 -04:00
karl
6a0d19ef5c Adding context to the documentation for metadata
Giving a longer description Thanks to justin mayer for #995
2013-08-03 12:47:44 -04:00
karl
03e9d0182d Fixing documentation according to Issue #362.
The documentation as it is right now produces a  CRITICAL: 'article' is
undefined
2013-08-03 00:31:43 -04:00
Justin Mayer
e9ca508e8e Add more detail to Pygments FAQ entry. Fixes #821 2013-05-06 07:28:25 -07:00
Justin Mayer
43f4d0df7a Add reST example to arbitrary metadata FAQ entry 2013-05-06 06:51:54 -07:00
Vlad Niculae
cdcfdf4605 DOC: fix the Markdown example for static index page URL override 2013-04-17 17:28:36 +09:00
Justin Mayer
8be7c0dbae Minor documentation improvements 2013-04-16 10:13:47 -07:00
Justin Mayer
ebee8e9b43 Update FAQ and changelog 2013-04-14 09:41:27 -07:00
Deniz Turgut
9936538d8b unify css class for pygments 2013-04-02 18:39:52 -04:00
Bruno Binet
802c9d1111 add docs for save_as/url override from metadata feature 2012-12-07 01:02:44 +01:00
Justin Mayer
a07b56c02b Doc fixes and improvements 2012-12-03 16:31:55 -08:00
Bruno Binet
e56d2b14c8 docfix: updates docs/settings.rst and docs/faq.rst 2012-11-12 23:44:12 +01:00
jawher
cf95b02bc0 Update the faq and changelog 2012-11-12 23:01:17 +01:00
Edward Delaporte
318518ee1f Added a second link to the issue tracker - for those who jump directly to the section without seeing the earlier section. 2012-10-28 14:32:48 -05:00
Justin Mayer
9dcf4e5438 Eliminate extraneous whitespace 2012-10-12 23:01:50 +02:00
Eric Case
be5b5e880d added a missing space 2012-08-21 14:14:10 -07:00
Justin Mayer
440a68636b Fix silly mistakes in last doc update 2012-08-08 10:27:45 -07:00
Justin Mayer
532001c851 Add FAQ entry re: arbitrary metadata in templates 2012-08-08 10:21:29 -07:00
Justin Mayer
beb4dccc8c Doc links changed to new domain. Other doc fixes. 2012-08-04 11:15:44 -07:00
Justin Mayer
24d5a6053e Various fixes and improvements to the docs 2012-08-01 18:20:12 -07:00
Alexis Metaireau
cf71ed75a4 the repositories are now hosted under 'getpelican' 2012-07-27 00:27:08 +02:00
tBunnyMan
625c1d167d Documentation Fix 2012-07-18 11:30:02 -07:00
tBunnyMan
4a9d2e86cf Moved all rss headers from FAQ into base 2012-07-16 14:52:19 -07: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
tBunnyMan
5f958ae84d Refactor atom feed names for clarity
FEED -> FEED_ATOM
TAG_FEED -> TAG_FEED_ATOM
CATEGORY_FEED -> CATEGORY_FEED_ATOM
2012-07-16 09:35:05 -07:00
tBunnyMan
1e8b05984a Add reference to FAQ statement about feeds 2012-07-14 18:26:33 -07:00
tBunnyMan
6393df3bfe Fix Spelling 2012-07-14 18:08:11 -07:00
tBunnyMan
d9817f9a96 Test for FEED & FEED_RSS before generation.
Then we bypass all feed generation of both are set to None or throw a warning if SITEURL is unset.
Updated all documentation, to make sure the usage and warning is clear.
2012-07-14 17:05:04 -07:00
tBunnyMan
dff5b3589b Add per page templates. Closes #376
Also set up helper classes in test_generators.py for cleaner tests
2012-07-07 14:15:43 -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
92b232972e add information about mardown in the FAQ 2011-11-27 18:00:29 +01:00
Alexis Metaireau
6b1434f7a7 Add a FAQ. 2011-01-19 16:22:15 +01:00