Skip to main content

Static Site Generator

Project description

Nib is a static site generator, written in Python, geared toward creating a simple site or blog, with the ability to generate metadata pages based on content attributes. It understands concepts like tags, archives, and paging series of individual entries into larger blocks of content. It is designed to be easily extended to create new content types with customized behaviors.

Concept

Nib reads in hierarchical directory of Markdown-formatted documents that contain YAML-formatted headers with attributes and metadata. The metadata includes a document type, which maps back to a series of predefined document processors, as well as arbitrary attributes.

Document processors are then given a list of all documents that match the processor’s document type, then returns a modified list of documents. Processors can modify existing documents, or optionally generate a set of “virtual” pages to include in its return value, allowing processors to create archives, tag pages, and more.

Once all document processors have been run, document bodies are run through the Markdown processor, and then passed to the appropriate templates for final rendering and output to static files.

Static resources, such as CSS, Javascript, and images, are then matched to configurable resource processors and merged with the document output. This step allows for use of pre-processors or generators for static resources, such as LessCSS, JS minifiers, or image optimizers.

Requirements

  • Python 3

Installation

To install the latest official release:

$ pip3 install nib

or to install the version currently checked out from source:

$ python3 setup.py install

License

Nib is licensed under the MIT license. See the LICENSE file for details.

Credits

Nib is developed by [John Reese](http://noswap.com) as a labor of love. It builds on top of many fine projects from the open source community, such as:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Nib-0.3.2.tar.gz (8.4 kB view details)

Uploaded Source

File details

Details for the file Nib-0.3.2.tar.gz.

File metadata

  • Download URL: Nib-0.3.2.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Nib-0.3.2.tar.gz
Algorithm Hash digest
SHA256 4fae76d1a55210ec707bf3d9ebd69397d3290bbbf7a76101abde798534a07c62
MD5 c738b85798bb0ce99bebacb2565648c5
BLAKE2b-256 736e76857f14c1fc4afe27424aa3d30820e67cd3d8e4563690467b17a39c86c2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page