Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blocknotes/manual-generator
Crystal tool to generate PDF manuals from HTML documentation sites
https://github.com/blocknotes/manual-generator
crystal pdf-manuals wkhtmltopdf
Last synced: 30 days ago
JSON representation
Crystal tool to generate PDF manuals from HTML documentation sites
- Host: GitHub
- URL: https://github.com/blocknotes/manual-generator
- Owner: blocknotes
- License: mit
- Archived: true
- Created: 2017-01-22T15:12:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-12T15:58:02.000Z (over 4 years ago)
- Last Synced: 2024-08-03T17:13:56.752Z (4 months ago)
- Topics: crystal, pdf-manuals, wkhtmltopdf
- Language: Crystal
- Homepage:
- Size: 642 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - manual-generator - Tool to generate PDF manuals from documentation sites (Misc)
README
# manual-generator - PROJECT UNMAINTAINED
> *This project is not maintained anymore*
>
> *If you like it or continue to use it fork it please.*
* * *
* * *
A Crystal program to generate PDF manuals from an HTML documentation site.
It gets all the links found in a table of contents element, downloads them and converts to a unique PDF using [wkhtmltopdf-crystal](https://github.com/blocknotes/wkhtmltopdf-crystal).
## Install
Build the binary tool:
`crystal build --release src/manual-generator.cr`
## Usage / Command line options
```
Usage: manual-generator [arguments] URL
-a STRING, --attribute=STRING CSS attribute to use for TOC links (default: "href")
-b, --include-base-url Include base URL document in PDF (default: false)
-c STRING, --content=STRING CSS element selector to look for the contents of the page (ex. "#content")
-e STRING, --extra-css=STRING Extra CSS styles (ex. "#nav_bar { display: none; }")
-o FILE, --output=FILE Output filename (default: doc.pdf)
-r, --remote-css Fetch remote CSS styles (default: false)
-s FILE, --custom-css=FILE Filename with custom CSS
-t STRING, --toc=STRING CSS element selector to look for the table of contents of the page (ex. "#summary a")
-h, --help Show this help
-v, --version Show version
-V, --verbose Verbose mode
```
## Examples
```sh
manual-generator -V "https://crystal-docs.org/blocknotes/wkhtmltopdf-crystal/" -c "#main-content" -t "#types-list a" -o test.pdf
```
See [examples](https://github.com/blocknotes/manual-generator/tree/master/examples) folder.
## Contributors
- [Mattia Roccoberton](http://blocknot.es) - creator, maintainer