github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify FAQ entry re: need to install Markdown

Browse source 
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.
This commit is contained in:
Justin Mayer 2013-10-19 17:20:13 +02:00
commit ae2afa27fc
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/faq.rst
View file

@ -65,12 +65,13 @@ How do I create my own theme?
Please refer to :ref:`theming-pelican`. Please refer to :ref:`theming-pelican`.
I want to use Markdown, but I got an error. I'm using Markdown and getting ``No valid files found in content`` errors.
=========================================== ==========================================================================
Markdown is not a hard dependency for Pelican, so you will need to explicitly Markdown is not a hard dependency for Pelican, so if you have content in
install it. You can do so by typing the following command, prepending ``sudo`` Markdown format, you will need to explicitly install the Markdown library.
if permissions require it:: You can do so by typing the following command, prepending ``sudo`` if
permissions require it::
pip install markdown pip install markdown