New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

corvid

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

corvid

An opinionated simple static site generator

1.1.1
PyPI

Maintainers: 1

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.

Keywords

static markdown

FAQs

What is corvid?

Is corvid well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

corvid

corvid

Installation

Running

Example

Using templates

Keywords

Related posts

Linux Foundation Warns Open Source Developers: Compliance with Sanctions Is Not Optional

Maven Central Adds Sigstore Signature Validation