weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity
pelican-theme/docs/index.rst

83 lines
2.2 KiB
ReStructuredText
Raw Normal View History

Include version in doc and warn if it's a dev version.
2013-03-27 09:16:19 +01:00
Pelican |release|
=================
.. ifconfig:: release.endswith('.dev')
.. warning::
Docs: Reflow to 79 char line limit
2018-11-02 20:53:15 -06:00
This documentation is for the version of Pelican currently under
development. Were you looking for version |last_stable| documentation?
Include version in doc and warn if it's a dev version.
2013-03-27 09:16:19 +01:00
Update the documentation.
2010-12-14 15:31:11 +00:00
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
Pelican is a static site generator, written in Python_. Highlights include:
Update the documentation.
2010-12-14 15:31:11 +00:00
Docs: Reflow to 79 char line limit
2018-11-02 20:53:15 -06:00
* Write your content directly with your editor of choice in reStructuredText_
or Markdown_ formats
Minor documentation improvements
2013-04-16 10:13:47 -07:00
* Includes a simple CLI tool to (re)generate your site
* Easy to interface with distributed version control systems and web hooks
Improve English documentation with enhanced clarity, grammar, and spelling
2012-03-06 06:13:17 -08:00
* Completely static output is easy to host anywhere
Update the documentation.
2010-12-14 15:31:11 +00:00
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
Ready to get started? Check out the :doc:`Quickstart<quickstart>` guide.
Update the documentation.
2010-12-14 15:31:11 +00:00
Features
Prepare for 3.0 release, make README more readable Since PyPI doesn't seem to handle anything but the most basic of reST formatting, moving the inline links to the end of the file should improve readability when the file is viewed in its raw form. Also updated changelog with the 3.0 release date.
2012-08-06 07:40:10 -07:00
--------
Update the documentation.
2010-12-14 15:31:11 +00:00
Update Pelican feature documentation
2021-04-21 10:16:28 +02:00
Pelican’s feature highlights include:
Update the documentation.
2010-12-14 15:31:11 +00:00
Minor documentation improvements
2013-04-16 10:13:47 -07:00
* Articles (e.g., blog posts) and pages (e.g., "About", "Projects", "Contact")
Update Pelican feature documentation
2021-04-21 10:16:28 +02:00
* Integration with external services
* Site themes (created using Jinja2_ templates)
Improve English documentation with enhanced clarity, grammar, and spelling
2012-03-06 06:13:17 -08:00
* Publication of articles in multiple languages
Update Pelican feature documentation
2021-04-21 10:16:28 +02:00
* Generation of Atom and RSS feeds
Improve English documentation with enhanced clarity, grammar, and spelling
2012-03-06 06:13:17 -08:00
* Code syntax highlighting
Update Pelican feature documentation
2021-04-21 10:16:28 +02:00
* Import existing content from WordPress, Dotclear, or RSS feeds
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
* Fast rebuild times thanks to content caching and selective output writing
Update Pelican feature documentation
2021-04-21 10:16:28 +02:00
* Extensible via a rich plugin ecosystem: `Pelican Plugins`_
Update the documentation.
2010-12-14 15:31:11 +00:00
Various fixes and improvements to the docs
2012-08-01 18:20:12 -07:00
Why the name "Pelican"?
Prepare for 3.0 release, make README more readable Since PyPI doesn't seem to handle anything but the most basic of reST formatting, moving the inline links to the end of the file should improve readability when the file is viewed in its raw form. Also updated changelog with the 3.0 release date.
2012-08-06 07:40:10 -07:00
-----------------------
Update the documentation.
2010-12-14 15:31:11 +00:00
Doc links changed to new domain. Other doc fixes.
2012-08-04 11:15:44 -07:00
"Pelican" is an anagram for *calepin*, which means "notebook" in French. ;)
Update the documentation.
2010-12-14 15:31:11 +00:00
Source code
Prepare for 3.0 release, make README more readable Since PyPI doesn't seem to handle anything but the most basic of reST formatting, moving the inline links to the end of the file should improve readability when the file is viewed in its raw form. Also updated changelog with the 3.0 release date.
2012-08-06 07:40:10 -07:00
-----------
Update the documentation.
2010-12-14 15:31:11 +00:00
Doc links changed to new domain. Other doc fixes.
2012-08-04 11:15:44 -07:00
You can access the source code at: https://github.com/getpelican/pelican
Update the documentation.
2010-12-14 15:31:11 +00:00
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-05-26 12:32:05 +02:00
How to get help, contribute, or provide feedback
------------------------------------------------
Update the documentation.
2010-12-14 15:31:11 +00:00
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-05-26 12:32:05 +02:00
See our :doc:`feedback and contribution submission guidelines <contribute>`.
Update the documentation.
2010-12-14 15:31:11 +00:00
Switch back the theme. Order the settings.
2010-12-15 18:01:29 +00:00
Documentation
Prepare for 3.0 release, make README more readable Since PyPI doesn't seem to handle anything but the most basic of reST formatting, moving the inline links to the end of the file should improve readability when the file is viewed in its raw form. Also updated changelog with the 3.0 release date.
2012-08-06 07:40:10 -07:00
-------------
Switch back the theme. Order the settings.
2010-12-15 18:01:29 +00:00
.. toctree::
:maxdepth: 2
importer - add documentation
2011-08-03 22:06:10 +02:00
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
quickstart
install
content
publish
Switch back the theme. Order the settings.
2010-12-15 18:01:29 +00:00
settings
Plugins doc + minor design changes.
2011-06-18 01:03:53 +02:00
plugins
Add Pelican theme repo link to docs
2021-10-05 07:38:24 +02:00
themes
Update the features proposed by pelican on the doc.
2011-07-22 02:12:10 +02:00
pelican-themes
importer - add documentation
2011-08-03 22:06:10 +02:00
importer
Add a FAQ.
2011-01-19 16:22:15 +01:00
faq
add ghp-import features to push to github pages easily
2011-08-19 23:01:01 +02:00
tips
Add some informations about how to contribute. This would need a more precise description and some good practices to follow.
2011-05-10 23:41:27 +01:00
contribute
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
internals
add some docs written a long time ago
2011-11-30 21:11:50 +01:00
report
Move changelog into docs
2012-07-18 18:41:09 +02:00
changelog
Prepare for 3.0 release, make README more readable Since PyPI doesn't seem to handle anything but the most basic of reST formatting, moving the inline links to the end of the file should improve readability when the file is viewed in its raw form. Also updated changelog with the 3.0 release date.
2012-08-06 07:40:10 -07:00
.. Links
Update http:// links to https:// where appropriate
2019-04-25 15:08:04 +02:00
.. _Python: https://www.python.org/
Prepare for 3.0 release, make README more readable Since PyPI doesn't seem to handle anything but the most basic of reST formatting, moving the inline links to the end of the file should improve readability when the file is viewed in its raw form. Also updated changelog with the 3.0 release date.
2012-08-06 07:40:10 -07:00
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
Update http:// links to https:// where appropriate
2019-04-25 15:08:04 +02:00
.. _Markdown: https://daringfireball.net/projects/markdown/
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 09:38:35 -05:00
.. _Jinja2: https://palletsprojects.com/p/jinja/
Update http:// links to https:// where appropriate
2019-04-25 15:08:04 +02:00
.. _`Pelican documentation`: https://docs.getpelican.com/latest/
.. _`Pelican's internals`: https://docs.getpelican.com/en/latest/internals.html
Update Pelican feature documentation
2021-04-21 10:16:28 +02:00
.. _`Pelican Plugins`: https://github.com/pelican-plugins
Copy permalink