diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 0952c7d9..7592a5ef 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -190,6 +190,42 @@ syntax for Markdown posts should follow this pattern:: This is the content of my super blog post. +Lastly, you can use Vanilla HTML (files ending in ``.htm`` and ``.html``). Pelican +interprets the HTML in a very straightforward manner, reading meta data out +of ``meta`` tags, the title out of the ``title`` tag, and the body out of the +``body`` tag:: + + + + My super title + + + + + + + This is the content of my super blog post. + + Content continues down here. + + + +With HTML, there are two simple exceptions to the standard metadata. First, +``tags`` can be specified either with the ``tags`` metadata, as is standard in +Pelican, or with the ``keywords`` metadata, as is standard in HTML. The two can +be used interchangeably. The second note is that summaries are done differently +in HTML posts. Either a ``summary`` metadata tag can be supplied, or, as seen +above, you can place an HTML comment, ````, that +Pelican will recognize. Everything before the comment will be treated as a +summary. The content of the post will contain everything in the body tag, with +the special comment stripped out. + +Note that, aside from the title, none of this metadata is mandatory: if the date +is not specified, Pelican will rely on the file's "mtime" timestamp, and the +category can be determined by the directory in which the file resides. For +example, a file located at ``python/foobar/myfoobar.rst`` will have a category of +``foobar``. + Note that, aside from the title, none of this metadata is mandatory: if the date is not specified, Pelican can rely on the file's "mtime" timestamp through the ``DEFAULT_DATE`` setting, and the category can be determined by the diff --git a/docs/internals.rst b/docs/internals.rst index cadd300b..704122ba 100644 --- a/docs/internals.rst +++ b/docs/internals.rst @@ -23,8 +23,8 @@ The logic is separated into different classes and concepts: on. Since those operations are commonly used, the object is created once and then passed to the generators. -* **Readers** are used to read from various formats (AsciiDoc, Markdown and - reStructuredText for now, but the system is extensible). Given a file, they +* **Readers** are used to read from various formats (AsciiDoc, HTML, Markdown and + reStructuredText for now, but the system is extensible). Given a file, they return metadata (author, tags, category, etc.) and content (HTML-formatted). * **Generators** generate the different outputs. For instance, Pelican comes with