Examples¶
Examples are available in the genja repository on GitHub. See the sections below for more information about each example.
Building the examples¶
The examples are located in the genja/examples directory in the GitHub repository. Use the genja build or genja serve command to generate the HTML for a particular example. For instance, use the commands shown below to build the website and run a local server for the directory-nocat example. The example website will automatically reload in the web browser when changes are saved to the Markdown files.
cd examples/directory-nocat
genja serve
Use the commands shown below to build the example website without starting a local server.
cd examples/directory-nocat
genja build
Directory output with no categories¶
The directory-nocat example uses the mysite directory for the generated HTML output. The Markdown files are located in the _pages and _posts directories. The Markdown files are not organized into categories using sub-directories. The _templates directory contains the Jinja templates.
directory-nocat/
├── mysite/
│ ├── img/
│ └── styles.css
├── _pages/
│ ├── about.md
│ └── contact.md
├── _posts/
│ ├── apple.md
│ └── orange.md
├── _templates/
│ ├── index.html
│ ├── page.html
│ └── post.html
└── genja.toml
Directory output with categories¶
The directory-withcat example uses the mysite directory for the generated HTML output. The Markdown files are located in the _pages and _posts directories. The Markdown files are organized into categories using sub-directories. The _templates directory contains the Jinja templates.
directory-withcat/
├── mysite/
│ ├── img/
│ └── styles.css
├── _pages/
│ ├── about.md
│ └── contact.md
├── _posts/
│ ├── fruits/
│ └── veggies/
├── _templates/
│ ├── index.html
│ ├── page.html
│ └── post.html
└── genja.toml
Top-level output with no categories¶
The toplevel-nocat example uses the root directory for the generated HTML output. The Markdown files are located in the _pages and _posts directories. The Markdown files are not organized into categories using sub-directories. The _templates directory contains the Jinja templates.
toplevel-nocat/
├── img/
│ └── apple.jpg
├── _pages/
│ ├── about.md
│ └── contact.md
├── _posts/
│ ├── apple.md
│ └── orange.md
├── _templates/
│ ├── index.html
│ ├── page.html
│ └── post.html
├── genja.toml
└── styles.css
Top-level output with no pages¶
The toplevel-nopages example uses the root directory for the generated HTML output. The Markdown files are located in the _posts directory, there is no _pages directory for this example. The Markdown files are not organized into categories using sub-directories. The _templates directory contains the Jinja templates.
toplevel-nopages/
├── img/
│ └── apple.jpg
├── _posts/
│ ├── apple.md
│ └── orange.md
├── _templates/
│ ├── index.html
│ └── post.html
├── genja.toml
└── styles.css
Top-level output with categories¶
The toplevel-withcat example uses the root directory for the generated HTML output. The Markdown files are located in the _pages and _posts directories. The Markdown files are organized into categories using sub-directories. The _templates directory contains the Jinja templates.
toplevel-withcat/
├── img/
│ └── apple.jpg
├── _pages/
│ ├── about.md
│ └── contact.md
├── _posts/
│ ├── fruits/
│ └── veggies/
├── _templates/
│ ├── index.html
│ ├── page.html
│ └── post.html
├── genja.toml
└── styles.css