3 releases
0.0.3 | Jun 23, 2021 |
---|---|
0.0.2 | May 28, 2020 |
0.0.1 | May 24, 2020 |
#1871 in Text processing
40KB
939 lines
Nib CLI
nib-cli
is a command line utility to a yet another static site generator Nib.
Usage
Installation
% cargo install nib-cli
Configuration
# e.g.
% cat config.toml
[website]
title = "An awesome blog"
description = """
"""
lang = "en" # language_code
url = "http://127.0.0.1:3000"
# the top most directory (e.g. blog) will be omitted in url
include = [
"blog/**/*.rst"
]
license = "CC-BY-NC-SA-4.0"
# this or [[website.metadata.authors]] either is required
# authors = [
# "Yasuhiro Яша Asaka <yasuhiro.asaka@grauwoelfchen.net>",
# ]
[build]
target-dir = "dst"
[[website.metadata.authors]]
name = "Yasuhiro Яша Asaka"
nick = "grauwoelfchen"
bio = """
A Programmer. I'm hacking on Gentoo/Funtoo Linux. I love greens and vegetables.
"""
email = "yasuhiro.asaka@grauwoelfchen.net"
avatar = "https://www.gravatar.com/avatar/...?s=40"
Writing article
% cat blog/post/article.rst
.. title:: Nice foo
.. lang:: en # optional
.. date:: 2018-01-31 12:04:00 UTC
.. description:: This is an article about nice foo. # optional
.. slug:: foo.html # optional (default filename as is)
Foo is nice! # above blank line before content is required
Generate
Put your articles under a directory which is contained in include
section in
config file.
# e.g. blog
% tree blog
blog
├── post
│ └── article.rst
└── hello-word.rst
And then generate HTML files into a directory specified with target-dir
.
% nib
The output result looks like this:
% tree dst
dst
├── css
│ └── index.css
├── hello-world.html
├── img
├── index.html
├── js
└── post
└── foo.html
Development
See nib-server
.
License
Apache-2.0
See LICENSE
Dependencies
~12–22MB
~291K SLoC