Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iwillig/bmtk
A set of tools for publishing markdown based books
https://github.com/iwillig/bmtk
clojure mapnik markdown pandoc plantuml
Last synced: about 1 month ago
JSON representation
A set of tools for publishing markdown based books
- Host: GitHub
- URL: https://github.com/iwillig/bmtk
- Owner: iwillig
- Created: 2024-01-20T12:56:04.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-01-20T16:43:23.000Z (10 months ago)
- Last Synced: 2024-09-29T17:22:50.209Z (about 2 months ago)
- Topics: clojure, mapnik, markdown, pandoc, plantuml
- Language: Clojure
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Book and mapping tool kit (BMTK)
This project is a collection of command line tools that helps folks
author books in Markdown.
## Pandoc
It follows the pandoc method for building
ebooks. https://pandoc.org/MANUAL.html#epubs
Pandoc uses a yaml file metadata and folder of markdown files.
Example of metadata file
```yaml
title:
- type: main
text: My Book
- type: subtitle
text: An investigation of metadata
creator:
- role: author
text: John Smith
- role: editor
text: Sarah Jones
identifier:
- scheme: DOI
text: doi:10.234234.234/33
publisher: My Press
rights: © 2007 John Smith, CC BY-NC
ibooks:
version: 1.3.4
```
## Citation Style Language
Pandoc also supports a couple of different citation styles. This tool uses, CSL YAML
https://docs.citationstyles.org/en/stable/specification.html
## Tools
- `check-grammar`: Command line tool that parses markdown and uses language tools.
- `publish pdf`: From a folder of markdown files, uses pandoc to generate.
- `publish ebook`: From a folder of markdown files.
- `index build`: Builds a SQLite Index from your markdown folder.
## Installation
### Make
### JVM
#### Install clojure-cli
Please follow the Clojure docs to install clojure-cli
[Install docs](https://clojure.org/guides/install_clojure)
#### Install JVM libraries and compile Clojure
```shell
make rebel
user=>(dev)
:ok
dev=>
```
### Mapnik (optional)
#### Ubuntu
```shell
sudo apt install libmapnik3.1 python3-mapnik libmapnik-dev
```
### Yarn
```shell
yarn
```
## Usage
### check-grammar
Checks the grammar of a folder of markdown files. Prints a list of
grammatical errors based on the language-tools library. Initial focus
is English, but language tools supports a wide range of languages.
https://dev.languagetool.org/java-api.html
TODO:
- Rust style error reporting
https://jvns.ca/blog/2022/12/02/a-couple-of-rust-error-messages/
-
```shell
check-grammar --help
check-grammar --folder chapters
check-grammar --fail-fast --folder chapters
```