Frederik Elwert
92050d90bc
Add FAQ regarding theme overrides
...
Currently, the documentation refers to creating new themes a lot.
It is much less apparent how one can customize an existing theme by
overriding individual templates or adding new ones. This commit adds
an FAQ for this, and also mentions the mechanism in the FAQ on custom
templates.
2024-10-10 14:35:07 +02:00
Justin Mayer
bb0ed26fdd
Document how to have same source & output hierarchy
2024-07-30 10:00:36 +02:00
Deniz Turgut
86d6898517
remove WRITE_SELECTED
...
Implementation is buggy and unreliable. Therefore, it is better to
remove the functionality until a robust implementation is added.
2023-11-12 19:43:26 +03:00
Jorge Maldonado Ventura
b260b3838e
Fix grammar errors/typos from docs/faq.rst
2023-06-24 13:29:02 +02:00
Justin Mayer
2a7e691000
Document switch from IRC to GitHub Discussions
2022-09-15 16:33:19 +02:00
Justin Mayer
68817845b0
Change FAQ entry to new Tag Cloud plugin repo
2021-02-18 12:30:44 +01:00
Justin Mayer
659c4cbf0f
Merge pull request #2836 from namn/patch-1
...
Fix typo in the FAQ: steamline --> streamline.
2021-01-07 17:17:14 +01:00
Justin Mayer
b17e4a5ffa
Add FAQ re: Atom full-post vs. summary-only feeds
...
Replaces a FAQ about upgrading from a very old version of Pelican, which
isn't relevant to most folks at this point.
2021-01-06 07:36:21 +01:00
Nam Nguyen
783a70da46
Fix typo in the FAQ: steamline --> streamline.
2021-01-03 21:24:10 -08:00
Justin Mayer
16975bc3a2
Prefix Pip commands with python -m in docs
...
This ensures Pip commands will be executed for the current Python
interpreter and not, say, whichever Python interpreter happens to be
associated with `/usr/local/bin/pip`.
2020-08-17 07:04:00 +02:00
Justin Mayer
f0841dc454
Add FAQ entry about Markdown syntax variants
2020-05-17 06:28:04 +02:00
Kurt McKee
7bbd3dc6fb
Update links to HTTPS and current 301 redirects in docs/templates/themes ( #2661 )
...
This also updates the Tumblr API to use HTTPS as documented in the
current Tumblr API docs.
2020-04-12 16:38:35 +02:00
MinchinWeb
f595741b8e
Docs: Reflow to 79 char line limit
2018-11-02 20:53:15 -06:00
Justin Mayer
550ffe4599
Remove spurious whitespace in documentation source
2016-12-03 14:53:26 -08:00
derwinlu
65f0f31b7b
Add FAQ about static files parsed as content
...
Since #1509 got merged this pops up again and again (latest #1845 ). This
PR addresses the issue by adding a FAQ about it that explains why it is
necessary to add `*_EXCLUDES`.
2015-10-17 17:00:16 +02:00
derwinlu
43a872c98a
add missing linebreak
2015-10-17 16:48:41 +02:00
Justin Mayer
de6bd537b5
Fix FAQ header underlines
2015-08-16 10:37:43 -07:00
Justin Mayer
bd3bec493e
Fix reST error in docs
2015-08-16 10:14:49 -07:00
Justin Mayer
5dc6d2914e
Minor tweaks to FAQ docs
2015-08-16 09:57:55 -07: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
winlu
3effe464c6
add faq entry about tag-cloud outsourcing
2015-04-20 16:36:18 +02:00
Matthias Bussonnier
f56b699d5b
Fix quotes in faq
2015-02-06 14:30:02 -08:00
Ondrej Grover
369b8b8474
note that {ARTICLE,PAGE}_PATHS may include files, add faq about using that
2014-11-04 17:00:01 +01:00
Ondrej Grover
f87e4faa22
add notices about caching interfering with changes to settings and plugins
2014-11-03 21:54:08 +01:00
Ondrej Grover
08044f2436
Mention the INDEX_SAVE_AS setting in FAQ and direct templates
...
This setting can be particularly useful when making a static homepage.
2014-11-03 20:43:33 +01:00
winlu
e4a2bb5b52
Update faq.rst
...
since author feeds are enabled per default http://docs.getpelican.com/en/latest/settings.html#id9 as well, these need to be added here as well.
2014-09-22 16:36:34 +02:00
Ondrej Grover
2e1b16826b
Enhance feedback and contributing guidelines
...
Many folks ask for help (via IRC or filing GitHub issues) without
sufficient detail and/or without first determining if the answers to
their questions might be better sourced elsewhere. These
documentation changes encourage users to follow certain guidelines
when reaching out for help.
2014-06-30 18:34:18 -07: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
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
