Skip to main content

An opinionated simple static site generator

Project description

corvid

corvid is an opinionated simple static site generator.

It processes Markdown files, static assets and directories producing a 1:1 heiarchy of compiled content.

It includes a reloadable local development server, supports custom markdown frontmatter and Jinja templates.

Installation

$ pip install corvid

Running

By default corvid expects to be run in a directory with an input directory. With no parameters, corvid will process all files in this directory into the output directory, and exit.

$ corvid --help
Usage: corvid [OPTIONS]

Options:
  -l, --listen          Enable live reloading
  -b, --bind TEXT       Host to bind to
  -p, --port INTEGER    Port to run on
  -i, --input TEXT      Input directory
  -o, --output TEXT     Output directory
  -t, --templates TEXT  Templates directory
  --help                Show this message and exit.

Example

Given the following directory layout:

├── input
│   └── index.md
└── templates
    └── default.html

With the following file contents:

input/index.md

---
title: This is the Index
---

Welcome

templates/default.html

<html>
    <head>
        <title>{{ title }}</title>
    <body>
        {{ content }}
    </body>
</body>

Running corvid will produce the additional output directory:

.
├── input
│   └── index.md
├── output
│   └── index.html
└── templates
    └── default.html

And the contents of the file will be:

output/index.html

<html>
    <head>
        <title>This is the Index</title>
    <head>
    <body>
        <p>Welcome</p>
    </body>
</body>

Using templates

Custom templates can be set by specifying the path to the template inside the templates directory as the template frontmatter.

See /example for a full example.

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

corvid-1.0.0.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

corvid-1.0.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file corvid-1.0.0.tar.gz.

File metadata

  • Download URL: corvid-1.0.0.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4

File hashes

Hashes for corvid-1.0.0.tar.gz
Algorithm Hash digest
SHA256 041c6f5f72cc2680c0ed19a650bc61d6589aa45f85980a9377ceb9a161143bab
MD5 33b7171dfbf73961dc6b9e0a011f0243
BLAKE2b-256 fc3fe92f4f507994dab84c2ee6eadc11534fea83857403a75b9005090f16be75

See more details on using hashes here.

File details

Details for the file corvid-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: corvid-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4

File hashes

Hashes for corvid-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0bc3e050a99584da31681762c9579e97c7d11dc10b9a2f2965fa2687c49d21af
MD5 2e7f8722779bedc8f6e380c974c5f8fe
BLAKE2b-256 3425254ccdb5e7653eb07e2d0fa60c325e7d3777f121234d93bf0aef80dc6f57

See more details on using hashes here.

Supported by

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