{"id":15010380,"url":"https://github.com/iwillig/bmtk","last_synced_at":"2026-03-16T15:36:46.242Z","repository":{"id":218242808,"uuid":"745886387","full_name":"iwillig/bmtk","owner":"iwillig","description":"A set of tools for publishing markdown based books","archived":false,"fork":false,"pushed_at":"2024-01-20T16:43:23.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-08T10:08:31.785Z","etag":null,"topics":["clojure","mapnik","markdown","pandoc","plantuml"],"latest_commit_sha":null,"homepage":"","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iwillig.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-20T12:56:04.000Z","updated_at":"2024-01-22T13:55:29.000Z","dependencies_parsed_at":"2024-01-20T17:59:59.283Z","dependency_job_id":null,"html_url":"https://github.com/iwillig/bmtk","commit_stats":null,"previous_names":["iwillig/bmtk"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iwillig%2Fbmtk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iwillig%2Fbmtk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iwillig%2Fbmtk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iwillig%2Fbmtk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iwillig","download_url":"https://codeload.github.com/iwillig/bmtk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243290897,"owners_count":20267810,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clojure","mapnik","markdown","pandoc","plantuml"],"created_at":"2024-09-24T19:33:49.381Z","updated_at":"2025-12-25T15:44:03.595Z","avatar_url":"https://github.com/iwillig.png","language":"Clojure","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Book and mapping tool kit (BMTK)\n\nThis project is a collection of command line tools that helps folks\nauthor books in Markdown.\n\n## Pandoc\n\nIt follows the pandoc method for building\nebooks. https://pandoc.org/MANUAL.html#epubs\n\nPandoc uses a yaml file metadata and folder of markdown files.\n\nExample of metadata file\n```yaml\ntitle:\n- type: main\n  text: My Book\n- type: subtitle\n  text: An investigation of metadata\ncreator:\n- role: author\n  text: John Smith\n- role: editor\n  text: Sarah Jones\nidentifier:\n- scheme: DOI\n  text: doi:10.234234.234/33\npublisher:  My Press\nrights: © 2007 John Smith, CC BY-NC\nibooks:\n  version: 1.3.4\n```\n\n## Citation Style Language\n\nPandoc also supports a couple of different citation styles. This tool uses, CSL YAML\n\nhttps://docs.citationstyles.org/en/stable/specification.html\n\n## Tools\n\n- `check-grammar`: Command line tool that parses markdown and uses language tools.\n- `publish pdf`: From a folder of markdown files, uses pandoc to generate.\n- `publish ebook`: From a folder of markdown files.\n- `index build`: Builds a SQLite Index from your markdown folder.\n\n## Installation\n### Make\n### JVM\n#### Install clojure-cli\nPlease follow the Clojure docs to install clojure-cli\n[Install docs](https://clojure.org/guides/install_clojure)\n#### Install JVM libraries and compile Clojure\n```shell\nmake rebel\nuser=\u003e(dev)\n:ok\ndev=\u003e\n```\n### Mapnik (optional)\n#### Ubuntu\n```shell\nsudo apt install libmapnik3.1 python3-mapnik libmapnik-dev\n```\n\n### Yarn\n```shell\nyarn\n```\n\n## Usage\n\n\n### check-grammar\n\nChecks the grammar of a folder of markdown files. Prints a list of\ngrammatical errors based on the language-tools library. Initial focus\nis English, but language tools supports a wide range of languages.\n\nhttps://dev.languagetool.org/java-api.html\n\nTODO:\n\n    - Rust style error reporting\n    https://jvns.ca/blog/2022/12/02/a-couple-of-rust-error-messages/\n    -\n\n```shell\ncheck-grammar --help\ncheck-grammar --folder chapters\ncheck-grammar --fail-fast --folder chapters\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiwillig%2Fbmtk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiwillig%2Fbmtk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiwillig%2Fbmtk/lists"}