discodoc - create documents from Discourse content easily
Project description
discodoc
About
discodoc - create hard copy-like documents from Discourse content easily.
It aims to make documentation generation effortless.
There might still be dragons.
Synopsis
# Generate PDF document from all posts of given topic. discodoc https://community.hiveeyes.org/t/anleitung-aufbau-und-installation-des-sensor-kits-grune-platine/2443 --format=pdf
For more information and further examples, please invoke discodoc --help.
Features
All output formats are provided by pandoc fame. These have been tested: pdf, docx, odt, pptx, epub2, epub3, fb2, latex, texinfo, txt, text, html, html5, json, plain, rtf, revealjs, s5.
Installation
Prerequisites
# Debian apt install texlive-latex-base pandoc # macOS / Homebrew brew install pandoc python3-requests brew cask install basictex
Optional:
brew cask install wkhtmltopdf
For HTML slideshow rendering:
yarn install wget https://meyerweb.com/eric/tools/s5/v/1.1/s5-11.zip cp -r ~/Downloads/s5-11/ui node_modules/s5
Setup
pip install discodoc
Caveats
If you are hitting one of the global rate limits and throttling in Discourse indicated like:
{"errors":["You’ve performed this action too many times, please try again later."]}
You might want to authenticate using an appropriate API key like:
export DISCOURSE_API_KEY=5c58bf5e4027622543f5179938182099c8b97188d00a9dc9f184cd3ca66db5ea
Credits
Donald Knuth and the LaTeX Team for conceiving and maintaining TeX and LaTeX.
John MacFarlane and all contributors for creating and curating pandoc.
The amazing Discourse Team and all contributors for creating Discourse and its spirit.
You know how you are. Thanks!
Other programs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file discodoc-0.3.0.tar.gz
.
File metadata
- Download URL: discodoc-0.3.0.tar.gz
- Upload date:
- Size: 19.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66cd37b67544f8cfedfc0c96c662476d6e6e208782d31ff7e2bade5aefac04e5 |
|
MD5 | b5b1499e1b292b33cb2453416f1092d5 |
|
BLAKE2b-256 | 86aa5e74fe8666e287f1d282a12e343b9d22e4caa38ed44c8bcf41407b4a047a |