OpenDocs
Turn any GitHub README, npm package, Markdown file, or Jupyter Notebook into
Word, PDF, PPTX, blog posts, JIRA tickets, and more — in one command.
Install
pip install opendocs
Core Command
opendocs generate <SOURCE> [OPTIONS]
Sources
| Source type |
Example |
| GitHub URL |
opendocs generate https://github.com/owner/repo |
| npm package |
opendocs generate npm:axios |
| Local file |
opendocs generate ./README.md --local |
| Jupyter Notebook |
opendocs generate ./notebook.ipynb --local |
| Folder of .md/.ipynb |
opendocs generate ./docs/ |
Key Options
| Option |
Default |
Description |
-f, --format |
all |
Output format: word, pdf, pptx, blog, jira, changelog, latex, onepager, social, faq, architecture, all |
-o, --output |
./output |
Directory for generated files |
--local |
off |
Treat SOURCE as a local path |
--token |
$GITHUB_TOKEN |
GitHub token for private repos |
--theme |
corporate |
Color theme: corporate, ocean, sunset, forest, minimal |
--mode |
basic |
basic (fast, no API key) or llm (AI-enhanced, needs --api-key) |
--api-key |
$OPENAI_API_KEY |
API key for LLM mode |
Common Usage
# Generate all formats from a GitHub repo
opendocs generate https://github.com/owner/repo
# Generate only a blog post from an npm package
opendocs generate npm:express --format blog
# Generate a Word doc from a local README
opendocs generate ./README.md --local --format word
# Generate docs from a whole folder, output to ./docs-out
opendocs generate ./docs/ --output ./docs-out
# AI-enhanced generation (richer content)
opendocs generate https://github.com/owner/repo --mode llm --api-key sk-...
# Use ocean theme, PDF only
opendocs generate https://github.com/owner/repo --format pdf --theme ocean
Output Files
All files are written to --output (default: ./output/).
File names follow the pattern <repo_name>_<format>.<ext>.
When to Use
- User asks: "generate docs for this repo" →
opendocs generate <url>
- User asks: "make a Word doc from the README" →
opendocs generate <url> --format word
- User asks: "create a blog post from npm:axios" →
opendocs generate npm:axios --format blog
- User asks: "export all the markdown files in ./docs" →
opendocs generate ./docs/
Source: ioteverythin/OpenDocs — distributed by TomeVault.
1---2name: ioteverythin-opendocs-opendocs3description: OpenDocs4---56# OpenDocs78Turn any GitHub README, npm package, Markdown file, or Jupyter Notebook into9Word, PDF, PPTX, blog posts, JIRA tickets, and more — in one command.1011## Install1213```bash14pip install opendocs15```1617## Core Command1819```bash20opendocs generate <SOURCE> [OPTIONS]21```2223## Sources2425| Source type | Example |26|---|---|27| GitHub URL | `opendocs generate https://github.com/owner/repo` |28| npm package | `opendocs generate npm:axios` |29| Local file | `opendocs generate ./README.md --local` |30| Jupyter Notebook | `opendocs generate ./notebook.ipynb --local` |31| Folder of .md/.ipynb | `opendocs generate ./docs/` |3233## Key Options3435| Option | Default | Description |36|---|---|---|37| `-f`, `--format` | `all` | Output format: `word`, `pdf`, `pptx`, `blog`, `jira`, `changelog`, `latex`, `onepager`, `social`, `faq`, `architecture`, `all` |38| `-o`, `--output` | `./output` | Directory for generated files |39| `--local` | off | Treat SOURCE as a local path |40| `--token` | `$GITHUB_TOKEN` | GitHub token for private repos |41| `--theme` | `corporate` | Color theme: `corporate`, `ocean`, `sunset`, `forest`, `minimal` |42| `--mode` | `basic` | `basic` (fast, no API key) or `llm` (AI-enhanced, needs `--api-key`) |43| `--api-key` | `$OPENAI_API_KEY` | API key for LLM mode |4445## Common Usage4647```bash48# Generate all formats from a GitHub repo49opendocs generate https://github.com/owner/repo5051# Generate only a blog post from an npm package52opendocs generate npm:express --format blog5354# Generate a Word doc from a local README55opendocs generate ./README.md --local --format word5657# Generate docs from a whole folder, output to ./docs-out58opendocs generate ./docs/ --output ./docs-out5960# AI-enhanced generation (richer content)61opendocs generate https://github.com/owner/repo --mode llm --api-key sk-...6263# Use ocean theme, PDF only64opendocs generate https://github.com/owner/repo --format pdf --theme ocean65```6667## Output Files6869All files are written to `--output` (default: `./output/`).70File names follow the pattern `<repo_name>_<format>.<ext>`.7172## When to Use7374- User asks: *"generate docs for this repo"* → `opendocs generate <url>`75- User asks: *"make a Word doc from the README"* → `opendocs generate <url> --format word`76- User asks: *"create a blog post from npm:axios"* → `opendocs generate npm:axios --format blog`77- User asks: *"export all the markdown files in ./docs"* → `opendocs generate ./docs/`7879---80> Source: [ioteverythin/OpenDocs](https://github.com/ioteverythin/OpenDocs) — distributed by [TomeVault](https://tomevault.io).81<!-- tomevault:4.0:skill_md:2026-07-03 -->