Norgowind
A modern, responsive theme for the Norgolith SSG, built with TailwindCSS. Norgowind provides a clean, customizable look for your Norgolith-powered site, with extra features and easy configuration.
Features
- Beautiful, responsive minimal design powered by TailwindCSS
- Ready-to-use templates for posts, categories, home, and more
- Customizable navigation and footer links
- Built-in icons support thanks to tabler icons library
- Mermaid.js support for diagrams and charts
- Additional blockquote styles (tip, note, important, warning, error)
- Truncation options for post cards
Demo
See Norgowind in action:
Showcase
Requirements
- Norgolith (latest commit on
masterbranch required) - TailwindCSS CLI (for development or custom styling)
Installation
lith theme pull github:NTBBloodbath/norgowind
Important
Norgowind requires the latest Norgolith commit in the master branch in order to work.
Usage
After installing, configure your site as described below. If you plan to modify the CSS, see the Tailwind Reloading section.
Configuration
Add the following fields to your norgolith.toml:
[extra]
license = "GPLv2" # Optional
favicon_path = "/assets/norgolith.svg" # Fallback to default favicon
footer_author_link = "https://github.com/NTBBloodbath" # Optional
enable_mermaid = true # Enable Mermaid.js for diagrams
[extra.nav]
# Link_name = "url"
# blog = "/posts"
# GitHub = "https://github.com/NTBBloodbath/norgolith"
[extra.footer]
# Link_name = "url"
# GitHub = "https://github.com/NTBBloodbath/norgolith"
Templates
Norgowind provides these templates:
templates
├── partials
│ ├── footer.html <- Footer content
│ └── nav.html <- Header navbar
├── base.html <- Main template (extends others)
├── categories.html <- Categories list
├── category.html <- Category posts list
├── default.html <- Default template for all content
├── home.html <- Homepage
├── post.html <- Blog post
└── posts.html <- Posts list
To use a template, set the layout metadata in your content files. For example, in a blog post:
layout: post
Tip
Norgolith expects your blog posts in the
content/postsdirectory.
MermaidJS Support
Norgowind comes with opt-in support for MermaidJS flowcharts. You can use mermaid charts through embedded HTML in your norg content if you set the enable_mermaid option to true in the extra table of your configuration file:
@embed html
<pre class="mermaid">
flowchart LR
A[HTML Fragment] --> B[Tera Engine]
C[Validated Metadata] --> B
D[Site Config] --> B
E[Post Collection] --> B
B --> F[Layout Template]
F --> G[Final HTML]
</pre>
@end
Additional Styling
Norgowind adds extra blockquote classes (use with +html.class tags):
tip(green)note(blue)important(violet)warning(yellow)error(red)
Additional Metadata Fields
truncate: Set the truncate character length for recent post cards.truncate_char: Set the truncate character (default is ellipsis). Leave empty to disable.
Tailwind Reloading
By default, Tailwind's configuration in Norgowind watches content files and templates. Each new class added to content using a +html.class tag will be included in the styling file.
For site development, install the TailwindCSS CLI and run:
tailwindcss -i theme/assets/css/tailwind.css -o theme/assets/css/styles.min.css --minify --watch
Contributing
Contributions, issues, and feature requests are welcome! Feel free to open an issue or pull request.
License
Norgowind is licensed under the MIT License.