Usage — Basics

Prerequisites

You may find information about how to install gresiblos at the Download and Installation page.

gresiblos is implemented in Python. It is started on the command line.

Basics

Assume you would have some text files with notes stored in a folder named “blog”. You can use gresiblos to turn them into a set of HTML pages with the following call:

gresiblos blog/*.txt --to-html

The contents of the text files will be first annotated with some basic HTML tags - links will be embedded in <a>-elements, and each line will be embedded into a paragraph (<p>) tag. The result is then embedded into the default template and written to the destination folder ./gresiblos_out.

The generated files will be named as your text files, though Python's urllib.parse.quote is applied to encode characters that are not compliant for being a part of an URL assuming the files will be uploaded to a server. Some further information is extracted from the files: the date using the file's change date, and the title using the file's file name.

In case your entries are stored as markdown files, you may install markdown additionally and start gresiblos with the --markdown option instead of using --to-html.

At subsequent pages, you will find some information about how the entries and the template can be enriched for obtaining full-fledged blog pages and about generating lists and indices or feeds to browse your blog.