mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Static site generator that supports Markdown and reST syntax. Powered by Python.
- Python 85.3%
- CSS 8.7%
- Jinja 6%
59750b3a85
I used the tool [htmlbeautify][1] like so
htmlbeautifier -t 4 -b 1 pelican/themes/simple/templates/*.html
htmlbeautifier -t 4 -b 1 pelican/themes/notmyidea/templates/*.html
and then manually adjusted the output. The final result follows the
following rules.
- 4-space indentation
- Multiline nested tags like
<tag1><tag2>
... nested content ...
</tag2></tag1>
are broken up into
<tag1>
<tag2>
... nested content ...
</tag2>
</tag1>
but if everything is on one like this
<tag1><tag2>... nested content ...</tag2></tag1>
it's OK.
- Treat new blocks like tags when indenting. E.g.
{% if cond %}
<p>hello</p>
{% endif %}
However, observe the following exceptions:
- Don't indent inside a {% block %}, {% macro %}, or if the block
takes up the entire file.
- If a {% for ... %} block takes up the entire content of an HTML tag,
don't indent it. E.g.
<ul id="navigation">
{% for item in navigation %}
<li><a href="{{ item.href }}">{{ item.caption }}</a></li>
{% endfor %}
</ul>
I tried to follow the examples in the official Jinja documentation as
closely as possible: <http://jinja.pocoo.org/docs/2.10/templates/>.
Used `git diff --check` to perform basic whitespace checks.
[1]: [https://github.com/threedaymonk/htmlbeautifier]
|
||
|---|---|---|
| docs | ||
| pelican | ||
| requirements | ||
| samples | ||
| .coveragerc | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| .travis.yml | ||
| bumpr.rc | ||
| CONTRIBUTING.rst | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| setup.cfg | ||
| setup.py | ||
| THANKS | ||
| tox.ini | ||
Pelican |build-status| |pypi-version| ===================================== Pelican is a static site generator, written in Python_. * Write content in reStructuredText_ or Markdown_ using your editor of choice * Includes a simple command line tool to (re)generate site files * Easy to interface with version control systems and web hooks * Completely static output is simple to host anywhere Features -------- Pelican currently supports: * Chronological content (e.g., articles, blog posts) as well as static pages * Integration with external services (e.g., Google Analytics and Disqus) * Site themes (created using Jinja2_ templates) * Publication of articles in multiple languages * Generation of Atom and RSS feeds * Syntax highlighting via Pygments_ * Importing existing content from WordPress, Dotclear, and other services * Fast rebuild times due to content caching and selective output writing Check out `Pelican's documentation`_ for further information. How to get help, contribute, or provide feedback ------------------------------------------------ See our `contribution submission and feedback guidelines <CONTRIBUTING.rst>`_. Source code ----------- Pelican's source code is `hosted on GitHub`_. If you feel like hacking, take a look at `Pelican's internals`_. Why the name "Pelican"? ----------------------- "Pelican" is an anagram of *calepin*, which means "notebook" in French. .. Links .. _Python: http://www.python.org/ .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Markdown: http://daringfireball.net/projects/markdown/ .. _Jinja2: http://jinja.pocoo.org/ .. _Pygments: http://pygments.org/ .. _`Pelican's documentation`: http://docs.getpelican.com/ .. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html .. _`hosted on GitHub`: https://github.com/getpelican/pelican .. |build-status| image:: https://img.shields.io/travis/getpelican/pelican/master.svg :target: https://travis-ci.org/getpelican/pelican :alt: Travis CI: continuous integration status .. |pypi-version| image:: https://img.shields.io/pypi/v/pelican.svg :target: https://pypi.python.org/pypi/pelican :alt: PyPI: the Python Package Index