KO
|
EN
gitlite — search
Search
#javascript
#python
#hacktoberfest
#react
#ai
#typescript
#llm
#go
#golang
#android
#machine-learning
#rust
#deep-learning
#linux
corvid
★ 11
Open GitHub ↗
An opinionated simple static site generator
Download README (.md)
Explore Similar Repositories
MultiServerCounter
:
A PocketMine-MP plugin that combines online players counts of multiple servers
ncov-statistics
:
武汉新型冠状病毒肺炎疫情热力统计图
ThermalCameraMod
:
AMG8833 thermal camera with ESP8266
docs
:
Repository for Unlock Protocol docs.
ByteToHeader
:
Simple C tool to generate a C header file with an array of bytes of given file.
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
corvid
?
Download (.md)
# 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 <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 <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`](https://raw.githubusercontent.com/di/corvid/master/example/input/foo/bar.md) for an example. See [`/example`](https://github.com/di/corvid/blob/master/example) for the full `input` -> `template` -> `output` folder structure.
