1
0
Fork 0
forked from github/pelican
Commit graph

74 commits

Author SHA1 Message Date
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
bef5e4479e Getting Started documentation overhaul 2013-04-16 19:45:46 -07:00
Justin Mayer
7b0165696e Clarify docs regarding pages. Fixes #847. 2013-04-14 15:08:32 -07:00
Justin Mayer
0d7c3e1b0a Remove allusion to Python versions less than 2.7 2013-04-11 19:27:20 -07:00
Justin Mayer
7364f77c0c Document supported Python versions 2013-04-11 19:23:34 -07:00
Rogdham
eb640b09e6 Add translation metadata support.
Allows user to control which posts are the translations independently of the
DEFAULT_LANG setting.
2013-04-06 18:36:37 +01:00
Alexis Métaireau
b9e2825da6 Put ASCII-art tree into a code-block element.
Fix #766
2013-03-10 20:15:37 -07:00
Talha Mansoor
a76bca9b0d Fixes the reST syntax of an example in the docs
reST example of the section "Linking to internal content" had incorrect
metadata. Moreover, time was missing from the date of both markdown and
reST example.

This was pointed out by [lefromage at #pelican](https://botbot.me/freenode/pelican/msg/2235275/)
2013-03-10 11:28:54 +05:00
Mark Caudill
45c42dfe9a Clarify internal linking. 2013-03-03 21:12:23 -08:00
dave mankoff
3f4406dd6b support inline summary specification
update documentation

change summary cutoff to a plugin

remove backup file

fix 3.2 tests

update summary plugin initialization and documentation

update documentation

fix documentation formatting
2013-02-12 22:35:02 -05:00
Randall Degges
7ec9ea92aa Fixing issue #712.
This commit adds documentation to the getting started guide which describes that
articles must contain a manually set 'date' metadata attribute unless the
DEFAULT_DATE setting is specified.

This fixes some incorrect documentation behavior discussed in the ticket.
2013-02-09 21:29:51 -08:00
dave mankoff
5f5b300ba5 fix documentation 2013-02-09 09:51:02 -05:00
dave mankoff
8ba6a4d19d fix documentation 2013-02-09 09:27:45 -05:00
dave mankoff
d5bfec3a8b update documentation and remove commented out code 2013-01-28 22:25:15 -05:00
dave mankoff
e6a4fe3fc4 fix grammar 2013-01-28 21:50:09 -05:00
dave mankoff
bf6f16e383 add documentation for html reader 2013-01-28 21:50:09 -05:00
Thanos Lefteris
a0b29d980f PyPI links for pelican depedencies 2012-12-25 23:59:53 +02:00
Thanos Lefteris
30c8825fa2 Docs update of the pelican core install depedencies 2012-12-25 23:36:44 +02:00
Justin Mayer
a07b56c02b Doc fixes and improvements 2012-12-03 16:31:55 -08:00
Bruno Binet
f86e1128f0 docfix: fix example of FILENAME_METADATA regexp 2012-12-03 10:20:43 +01:00
Bruno Binet
070fa1ff9d add more docs about FILENAME_METADATA 2012-12-03 10:20:40 +01:00
Bruno Binet
e14623b46c Merge pull request #611 from michaelreneer/master
Updated documentation
2012-12-02 12:25:40 -08:00
Brian C. Lane
49f481e399 Add asciidoc reader support
http://www.methods.co.nz/asciidoc/index.html

Processes files ending in .asc with asciidoc. Extra arguments can be
passed by using the ASCIIDOC_OPTIONS config setting
2012-12-02 10:20:13 -08:00
Michael Reneer
891a66ad8b Updated documentation to reflect addition of new markdown types. 2012-12-02 13:11:47 -05:00
Bruno Binet
81cb774a8e add docs for cross-site linking 2012-12-01 21:35:15 +01:00
Alexis Métaireau
c731edcdeb pages should be in the content folder 2012-11-29 19:16:44 +01:00
Tomi Pieviläinen
a6f328516a Metadata parity for RST/MD, document summary. 2012-11-24 13:18:49 +02:00
Alexis Métaireau
84c708b74b Revert "Get HtmlReader to work again"
This reverts commit 39db9ddcfd.

Conflicts:

	tests/test_readers.py
2012-10-29 00:36:42 +01:00
Alexis Métaireau
92d8208309 Merge branch 'master' of github.com:getpelican/pelican 2012-10-28 23:50:49 +01:00
Martin Brochhaus
47c972e21a Added USE_FOLDER_AS_CATEGORY setting.
This allows users to organize their files in ways where the subfolder name
would not make a good category name (i.e. /2012/09/). Set this to ``False``
and the subfolder will no longer be used as a standard category,
`DEFAULT_CATEGORY` will be used instead.
2012-10-28 20:43:45 +01:00
Alexis Métaireau
0ebba1c4ab merge with master 2012-10-25 14:54:19 +02:00
Alexis Métaireau
b349bdd80f Make it obvious in the docs that you need to indent the identifier as well 2012-10-25 14:37:19 +02:00
Justin Mayer
cd85151f97 Add Typogrify to docs as optional dependency 2012-10-12 23:01:50 +02:00
Justin Mayer
007cd9b8fd Minor doc changes, including those for webassets 2012-10-12 23:01:50 +02:00
Florian Jacob
39db9ddcfd Get HtmlReader to work again
wrote unit tests and documentation, improved regular expression.
The HtmlReader is enabled by default now and parses metadata in html
files of the form:
<!-- key:value -->
2012-09-02 10:29:09 +02:00
David Marble
831e1d04b9 docs: Pelican outputs to output/ not content/. Markdown ::: syntax must be indented 2012-08-23 18:31:45 -07:00
Justin Mayer
3bf377fd5f Minor doc fixes 2012-08-08 09:29:04 -07:00
Justin Mayer
a3e24949af Provide specific links to virtualenvwrapper docs
Rather than detail how to install and configure virtualenvwrapper, it
seems best to instead link to the appropriate external docs.
2012-08-06 06:11:54 -07:00
Feth Arezki
8f7a3044ec Update docs/getting_started.rst
virtualenvwrapper requires a shell restart
2012-08-06 14:24:38 +02:00
Justin Mayer
0c02536605 Give devserver its own make target
Restore "make serve" to a non-backgrounded SimpleHTTPServer process and
give the develop_server.sh its own make target at "make devserver".
Add a few missing make targets to the help list and re-order targets for
consistency. Add note to docs regarding how to stop the devserver.
2012-08-05 17:25:39 -07:00
Alexis Metaireau
cf71ed75a4 the repositories are now hosted under 'getpelican' 2012-07-27 00:27:08 +02:00
Dirkjan Ochtman
da5db5aac9 Add documentation for abbr in reST. 2012-07-18 18:22:31 +02:00
Justin Mayer
18b4d65c4e Clarify quickstart docs and remove spurious line 2012-07-07 08:45:50 -07:00
Justin Mayer
764a2cfa51 Add dual dev/publish modes to quickstart script
Certain configuration options are more useful in production than they
are in development. Some examples might be absolute URLs, external
analytics service identifiers, Disqus comments, etc. This version of the
quickstart script creates two configuration files: one for development
and the other for use when publishing. In addition, the related docs
have been expanded considerably. Last but not least, the quickstart
script will now detect whether there is a project folder associated with
the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
tBunnyMan
cb3c40256a Merge branch 'master' of github.com:ametaireau/pelican into DeleteContentsNotDirectory 2012-07-04 15:12:39 -07:00
Alexis Metaireau
ea0a964365 Merge pull request #389 from tbunnyman/issue#380
Add support for `status: hidden` in pages
2012-07-04 14:51:50 -07:00
tBunnyMan
d589450200 Change behavior of DELETE_OUTPUT_DIRECTORY to purge contents of the directory, not the directory itself.
Added Debug level logging for each deletion
Added error level logging when a delete has an exception
Built a test case for clean_output_directory in tests.utils.py
Updated `settings` in documentation to reflect new behavior
Removed the tip from the bottom of getting started since this setting should no longer break web servers pointing to the output directory.
2012-07-04 12:32:20 -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
tBunnyMan
c2993c4d4e Documentation typo 2012-06-27 07:02:25 -07:00
tBunnyMan
a0e46c9106 Add support for status: hidden in pages
Resolves #380 If the status metadata is set to 'hidden' on a page it is translated and rendered but not linked anywhere in the site.
2012-06-26 19:26:43 -07:00