Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trs/bomb-defusal-manual-generator
:bomb: Generate bomb defusal manual pages for mods!
https://github.com/trs/bomb-defusal-manual-generator
hacktoberfest
Last synced: 23 days ago
JSON representation
:bomb: Generate bomb defusal manual pages for mods!
- Host: GitHub
- URL: https://github.com/trs/bomb-defusal-manual-generator
- Owner: trs
- Created: 2017-12-19T04:52:45.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T16:42:44.000Z (about 1 year ago)
- Last Synced: 2024-12-12T00:44:23.570Z (27 days ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 1.19 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Generate Bomb Defusal Manual PDF pages
# Synopsis
Using markdown, custom bomb defusal manual pages can be generated. These pages are designed to mimic the existing manual pages.
# Install
```bash
$ npm install defusal --global
```
# Usage
```bash
$ defusal my_mod.md --name "My Cool Mod"
```
## Options
`-n --name {name}` The name of your mod, this will be the page header.
Defaults to `Mod`
`-v --version {version}` The version to use in the header.
Defaults to `Mod`
`-o --output {path}` The path of the final PDF page output.
Defaults to `./page.pdf`
# Pages
Pages are built using markdown, check out [pages](./pages) for some examples.
Parsing is done using [markdown-it](https://github.com/markdown-it/markdown-it) with the plugins [markdown-it-attrs](https://github.com/arve0/markdown-it-attrs), [markdown-it-multimd-table](https://github.com/RedBug312/markdown-it-multimd-table), and [markdown-it-underline](https://github.com/arve0/markdown-it-underline).