An open API service indexing awesome lists of open source software.

https://github.com/bc1bb/mkhtml

📝 mkhtml makes HTML files using header/footer file and pages
https://github.com/bc1bb/mkhtml

bash html rust rust-crate rust-lang

Last synced: 4 months ago
JSON representation

📝 mkhtml makes HTML files using header/footer file and pages

Awesome Lists containing this project

README

          

# mkhtml
Makes HTML files from `header.html` and `footer.html` and `pages`.

## Installation
```shell
cargo install mkhtml
# !OR!
brew tap jusdepatate/jusdepatate
brew install mkhtml
```

## Building
```shell
cargo build # dev
cargo build -r # release
```

## Usage
### As a binary
- put your header in `parts/header.html`,
- put your footer in `parts/footer.html`,
- put your pages in `pages/` (can have folders),
- `mkhtml build`. (`b` also works).

#### Arguments
By default `mkhtml` will build in the working directory but you can change that by using any of the following arguments:

- `--pages-dir [path]`,
- `--parts-dir [path]`,
- `--static-dir [path]`,
- `--build-dir [path]`.

(you can use one or more of them, you can use both absolute and relative paths).

#### As a library
Basic example:
```rust
extern crate mkhtmllib;
use mkhtmllib::{mkhtml, Config};

fn main() {
let mut c = Config::new();
c.set_pages_dir("path/".to_string());
mkhtml(c);
}
```