nib 0.0.2

A yet another static site generator
Documentation

Nib

A yet another static site generator.

Usage

Configuration

# e.g.
% cat config.toml
[website]
title = "An awesome blog"
description = """
"""
lang = "en" # language_code
url = "http://127.0.0.1:3000"
include = [
  "blog/**/*"
]
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"

Build

Put your articles under a directory which is contained in include section.

# e.g. blog
% tree blog
blog
└── hello-word.rst

And then generate HTML files into a directory specified with target-dir.

% make build
% ./target/debug/nib

The output result looks like this:

% tree dst
dst
├── css
   └── index.css
├── hello-world.html
├── img
├── index.html
└── js

Development

Start development server. It serves contents in dst by listening 127.0.0.1:300.

% make build:server
% ./target/debug/nib-server

License

Nib
Copyright 2020 Yasuhiro Яша Asaka

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.