Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add usage documentation #17

Closed
lebouquetin opened this issue Jun 27, 2024 · 1 comment
Closed

Add usage documentation #17

lebouquetin opened this issue Jun 27, 2024 · 1 comment

Comments

@lebouquetin
Copy link
Member

lebouquetin commented Jun 27, 2024

Syntax for content pages:

--- METADATA (first) ---
metadata value
--- DATA (second JSON Structure) ---
{}
--- BODY (last / third) ---
any content

metadata syntax --- METADATA (first) ---:

<name> <value> where:

  • name is a string without any space char
  • value is separated from name by a set of space chars (space, tab, etc)

Example: og:title Titre utilisé pour les métadonnées opengraph

Specific cases:

  • comments for lines starting by a #
  • blank lines: ignored

Data syntax --- DATA (second JSON Structure) ---:

The data section is interpreted as a large JSON-like string. Two exceptions in the "parsing":

  • lines starting with a # are ignored, considered being a comment
  • blank lines are ignored

Body syntax --- BODY (last / third) ---:

A standard HTML or Markdown content. HTML content may include jinja template stuff, like macros, blocks, etc

Note: the template engine used in the body section can be parameterized through the template_engine metadata (value to be set to jinja2 or django

@ClmntBcqt
Copy link
Contributor

Merged in #30

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants