1
0
Fork 0
forked from github/pelican
Commit graph

256 commits

Author SHA1 Message Date
Simon Conseil
6264cf8916 Clarify docs about the DIRECT_TEMPLATES _SAVE_AS and _URL settings. 2014-01-05 23:37:44 +01:00
Iuri de Silvio
fb1cfc35bf Change CATEGORIES_URL and CATEGORIES_SAVE_AS docs to
make it consistent with TAGS_URL and TAGS_SAVE_AS.

Add default values to CATEGORIES_URL and CATEGORIES_SAVE_AS.
2014-01-05 18:34:23 -02:00
Justin Mayer
505852c04c Use the actively maintained typogrify-web package
The Typogrify library is no longer actively maintained by the
original author. These changes switch Pelican over to a new fork that
will receive more consistent updates going forward.
2014-01-03 08:51:52 -08:00
Tom Yubing Dong
d935af3229 Update settings.rst to match tag cloud code
According to the implementation, the value of `tag.1` should be between 1 and `TAG_CLOUD_STEPS`, inclusive.

See:
https://github.com/getpelican/pelican/blob/master/pelican/generators.py#L457
2013-12-27 15:36:34 +08:00
Mitchell Tannenbaum
add9a0790d Added ARCHIVES_URL to settings.rst 2013-11-22 19:31:09 -05:00
David Marble
0c69f4ad84 Support ordering pages and articles when iterating in templates.
Order can be set to a metadata attribute or a sorting function.
Default to order by slug for articles and order by filename for pages.
2013-11-14 12:35:50 -08:00
John Cramb
da66245729 Update settings.rst
Added missing CATEGORIES_URL and CATEGORIES_SAVE_AS settings to the table.
2013-11-13 14:15:08 +11:00
Justin Mayer
cb82e48636 None, not False, in *_SAVE_AS docs. Fixes #1106. 2013-10-04 16:23:19 +02:00
Justin Mayer
f6c9237a01 Enhance and correct documentation 2013-09-23 19:30:51 +02:00
SDGSDG
3580233b38 Support for pygment defaults and relevant documentation 2013-09-15 23:13:17 -07:00
Alexis Metaireau
9935286e19 Merge pull request #1056 from bmcorser/fix-utils-copy
Fix for THEME_STATIC_PATHS by copying sensitively
2013-09-09 15:01:13 -07:00
Talha Mansoor
e2236d50d6 Update settings documentation to explain INTRASITE_LINK_REGEX
I have added reference to "Linking to internal content" section because
without it, it is difficult to explain the usage.

I have also updated changelog.

Closes getpelican/pelican#1061
2013-09-09 00:08:39 +05:00
bmcorser
ef16c915d4 Clarification of THEME_STATIC_PATHS behaviour 2013-08-31 21:49:41 +01:00
Daniel Goldsmith
d9816be5de Tag Cloud made functional 2013-08-13 10:46:41 +01:00
Justin Mayer
5a469dc2e3 Merge pull request #1011 from saimn/readers
Refactor readers and remove MARKUP. Fixes #866
2013-08-07 12:34:22 -07:00
Simon Conseil
f47f054d0b Add documentation for readers. 2013-08-07 00:43:49 +02:00
Danilo Bargen
42f9726ffa Support TAGS_* and AUTHORS_* by default. 2013-08-05 19:16:00 +02:00
Justin Mayer
bea03bb4bb Merge pull request #979 from nyergler/pagination_conf
Support flexible pagination configuration
2013-08-03 14:58:47 -07:00
Nathan Yergler
d61ef0c66c Adding basic documentation for PAGINATION_PATTERNS. 2013-08-03 14:06:16 -07:00
Russ Webber
89034f8b3f added THEME_STATIC_DIR setting
The theme static output directory path is now customisable via settings.
i.e. you can now use 'assets' instead of 'theme'.
2013-08-01 11:02:38 +08:00
Kyle Fuller
51dc02f298 Add documentation for WITH_FUTURE_DATES
Closes #952
2013-07-31 23:08:42 +01:00
Justin Mayer
f43742c3f0 Add missing SITEURL variable to tag cloud docs 2013-07-15 14:25:39 -07:00
Chris Howie
4ca5d908ff Update tag cloud documentation for SLUG_SUBSTITUTIONS 2013-07-15 16:48:08 -04:00
Andy Pearce
39518e15ef Allow text substitutions when generating slugs
The `slugify()` function used by Pelican is in general very good at
coming up with something both readable and URL-safe. However, there are
a few specific cases where it causes conflicts. One that I've run into
is using the strings `C++` and `C` as tags, both of which transform to
the slug `c`. This commit adds an optional `SLUG_SUBSTITUTIONS` setting
which is a list of 2-tuples of substitutions to be carried out
case-insensitively just prior to stripping out non-alphanumeric
characters. This allows cases like `C++` to be transformed to `CPP` or
similar. This can also improve the readability of slugs.
2013-07-04 12:17:21 +01:00
Justin Mayer
ddb6d89be3 Document how to stop generation of certain pages
The documentation doesn't make it very clear how to prevent certain
pages from being generated, such as the Authors, Tags, and Categories
collection pages. This change makes it slightly more obvious how to
prevent these pages from being generated. Fixes #940.
2013-06-28 19:59:00 -07:00
Danilo Bargen
931d571606 More explicit settings docs concerning list templates
I think the author list and tag list are so common that they should be
listed explicitly in the settings.
2013-06-28 00:55:22 +02:00
Justin Mayer
6f36b0a246 Keep certain files when cleaning output; fix #574
If DELETE_OUTPUT_DIRECTORY is set to True, all files and directories are
deleted from the output directory. There are, however, several reasons
one might want to retain certain files/directories and avoid their
deletion from the output directory. One such use case is version control
system data: a versioned output directory can facilitate deployment via
Heroku and/or allow the user to easily revert to a prior version of the
site without having to rely on regeneration via Pelican.

This change introduces the OUTPUT_RETENTION setting, a tuple of
filenames that will be preserved when the clean_output_dir function in
pelican.utils is run. Setting OUTPUT_RETENTION = (".hg", ".git") would,
for example, prevent the relevant VCS data from being deleted when the
output directory is cleaned.
2013-06-25 19:03:32 -07:00
W. Trevor King
ce0a9b697e Document path metadata extraction 2013-06-12 17:37:22 -04:00
W. Trevor King
d43dc1b9d6 Add the EXTRA_PATH_METADATA setting
Useful for altering static output paths when you don't want to encode
extra metadata in the static file's source path.
2013-06-12 15:02:31 -04:00
W. Trevor King
1ca0e06a27 Remove the FILES_TO_COPY setting
We no longer instantiate the Static object in the StaticGenerator, so
we can't set the save_as argument anymore.  If you want to adjust the
output path, use the upcoming EXTRA_PATH_METADATA setting.
2013-06-12 15:02:31 -04:00
Justin Mayer
1fcf4a6550 Add documentation for ARCHIVES_SAVE_AS setting
While this setting has existed for some time, there does not seem to
have been any documentation for it until now.
2013-06-10 19:42:53 -07:00
Justin Mayer
34f05d4ba6 Add warning to docs re: DELETE_OUTPUT_DIRECTORY 2013-05-02 17:18:19 -07:00
Deniz Turgut
be8837963a ignore emacs lock files and exception handling for watchers 2013-04-22 20:50:11 -04:00
Emily Strickland
08f27e0134 Accept mdown file extension for Markdown files.
This extension is sometimes used for Markdown files and is the default
for a few editors, such as Sublime Text.
2013-04-17 21:14:52 -07:00
Justin Mayer
8be7c0dbae Minor documentation improvements 2013-04-16 10:13:47 -07:00
Justin Mayer
0a8678a8ae Change RELATIVE_URLS default to False - Fixes #829 2013-04-11 16:12:55 -07:00
Deniz Turgut
9936538d8b unify css class for pygments 2013-04-02 18:39:52 -04:00
David Beitey
e042e11c23 Add new option for controlling whether to display categories on menu or not
Conflicts:
	docs/changelog.rst
	pelican/tests/output/basic/tag/bar.html
	pelican/tests/output/basic/tag/baz.html
	pelican/tests/output/basic/tag/foo.html
	pelican/tests/output/custom/tag/bar.html
	pelican/tests/output/custom/tag/baz.html
	pelican/tests/output/custom/tag/foo.html
2013-04-01 22:08:13 +10:00
Justin Mayer
c7f06b9af6 Merge pull request #786 from noirbizarre/more-documentation
Add missing documentation for JINJA_FILTERS and SITESUBTITLE
2013-03-20 13:29:13 -07:00
Axel Haustant
e235cadda4 Fix typos 2013-03-20 21:21:47 +01:00
Justin Mayer
439b783a72 Merge pull request #785 from wraithan/docs_for_ignore_files
documentation for IGNORE_FILES
2013-03-20 09:07:58 -07:00
Axel Haustant
7fb51e94bb Fix typos 2013-03-20 16:08:54 +01:00
Axel Haustant
c36fce8b6a Added missing SITESUBTITLE documentation 2013-03-19 14:58:35 +01:00
Axel Haustant
c6b943bfe9 Added missing JINJA_FILTERS documentation 2013-03-19 14:58:35 +01:00
Wraithan (Chris McDonald)
e73f7e9f84 documentation for IGNORE_FILES 2013-03-18 17:51:17 -07: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
W. Trevor King
bfa8851af0 Add the PATH_METADATA setting
Sometimes the base filename doesn't have everything you need.

Remember that os.sep is platform dependent, so using it in a regular
expression for this setting may not be portable (boo MS Windows!).
2013-03-12 15:16:25 -07:00
Jered Boxman
bfaa5f9d5c Added clearification in docs for PAGE_SAVE_AS
I discussed this option in the IRC channel, because I don't think it's
very clear. When I first read the list of options I was under the
impression that Pelican could do rewriting of urls. I discovered that
this isn't the case, so I discusses this in the IRC channel and got the
encouragement to submit a pull request.
2013-03-10 14:34:17 +01:00
Eric
7cafcf6c24 Fix the tag cloud example 2013-03-05 23:27:00 -08:00
Valentin-Costel Hăloiu
64ce845bae Fix typo 2013-02-10 00:38:18 +02:00