Metadata-Version: 2.1
Name: norite
Version: 0.1.0
Summary: A simple static website generator powered by Jinja2
Home-page: https://github.com/prdx23/norite
Author: Arsh
Author-email: hi@prdx.me
Project-URL: Source, https://github.com/prdx23/norite
Project-URL: Tracker, https://github.com/prdx23/norite/issues
Project-URL: Documentation, https://github.com/prdx23/norite/wiki
Keywords: static web site generator SSG jinja jinja2 markdown
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: toml
Requires-Dist: jinja2
Requires-Dist: markdown
Requires-Dist: watchdog
Requires-Dist: pygments

# Norite

Norite is a simple static website generator powered by [Jinja2](https://palletsprojects.com/p/jinja) as the templating engine.

Norite's main goal is to act as an easy to use rendering engine for people who like to design their own templates or want to have the option of building a custom structure for their websites. To achieve this goal norite exposes the entire content directory as a tree data-structure to the templates along with the rendered content, leaving it up to the template designer how to interpret and display this information.

Implemented Features:
- Markdown to HTML render
- Support for using toml or json files in place of markdown
- Jinja2 based HTML templates
- Support for embedding Jinja2 templates in markdown
- Support for nested folders in website content
- Support for custom templates for any subsection of the content folder
- Support for co-locating assets with content
- Syntax highlighting in code blocks
- Sass compilation (via libsass or dart-sass)
- In-built dev server with auto reload on file changes
- Support for building custom RSS/Atom feeds and robots.txt using templates
- Automatic sitemap.xml generation

Todo:
- Tests
- Nicer error messages
- Live reload in Javascript
- Incremental builds
- Link checker
- More examples


## Installation
norite is in alpha, but if you like what you see and want to give it a try, you can install using:
```shell
pip install norite
```

It will install the following additional packages: [jinja2](https://pypi.org/project/Jinja2/), [markdown](https://pypi.org/project/Markdown/), [toml](https://pypi.org/project/toml/), [pygments](https://pypi.org/project/Pygments/) and [watchdog](https://pypi.org/project/watchdog/).

Alternatively, if you want to install it globally as a shell tool within an isolated python environment, install via [pipx](https://pypa.github.io/pipx/):
```shell
pipx install 'norite'
```

## Documentation
Checkout the documentation for norite here: [documentation](https://github.com/prdx23/norite/wiki)


## Inspiration
Norite takes inspiration from [Zola's](https://www.getzola.org/) features and its way of organizing content, borrows a few concepts from [Hugo](https://gohugo.io), and references  [Pelican](https://blog.getpelican.com/)'s and [Mkdocs](https://www.mkdocs.org/)'s internal implementations for a few things. I would happily recommend using any of these excellent SSGs!


## License
**MIT License**: Copyright (c) 2022 - 2022 Arsh  
[License.txt](https://github.com/prdx23/norite/blob/master/LICENSE.txt)
