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

Fix docs/quickstart.rst to use reStructured Text.

Browse source 
Previously used .md, but markdown isn't in the default installation, so
using a format which is.  An alternative fix would be to show how to
install markdown in the quickstart.

Signed-off-by: Wilson Snyder <wsnyder@wsnyder.org>
This commit is contained in:
Wilson Snyder 2020-05-09 10:36:11 -04:00
commit 0bddaceca4
1 changed files with 10 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/quickstart.rst
View file

@ -38,14 +38,18 @@ Create an article
You cannot run Pelican until you have created some content. Use your preferred
text editor to create your first article with the following content::
Title: My First Review
Date: 2010-12-03 10:20
Category: Review
My First Review
###############
:date: 2010-12-03 10:20
:tags: reviews
:category: Review
:summary: My First Review
Following is a review of my favorite mechanical keyboard.
Given that this example article is in Markdown format, save it as
``~/projects/yoursite/content/keyboard-review.md``.
Given that this example article is in reStructuredText format, save it as
``~/projects/yoursite/content/keyboard-review.rst``.
Generate your site
------------------