Skip to content

di/corvid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

corvid

corvid is an opinionated simple static site generator.

It processes Markdown files, static assets and directories producing a 1:1 hierarchy 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.

Usage:
$ corvid [OPTIONS]

For help:
$ corvid --help

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>
    </head>
    <body>
        {{ content }}
    </body>
</html>

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>
</html>

Using templates

Custom templates can be set by specifying the path to the template (inside the templates directory) as the template frontmatter in an individual page. See bar.md for an example.

See /example for the full input -> template -> output folder structure.

About

An opinionated simple static site generator

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •