Agent Skills › ioteverythin/OpenDocs › opendocs

opendocs

GitHub

将GitHub仓库、npm包或本地Markdown/Jupyter文件转换为Word、PDF、PPTX等多种格式文档的工具。支持从源码生成博客、JIRA工单、FAQ等，适用于内容格式化与文档导出场景。

skills/opendocs/SKILL.md ioteverythin/OpenDocs

Trigger Scenarios

generate docs convert the README create a Word doc from the repo export to PDF

Install

npx skills add ioteverythin/OpenDocs --skill opendocs -g -y

More Options

Use without installing

npx skills use ioteverythin/OpenDocs@opendocs

指定 Agent (Claude Code)

npx skills add ioteverythin/OpenDocs --skill opendocs -a claude-code -g -y

安装 repo 全部 skill

npx skills add ioteverythin/OpenDocs --all -g -y

预览 repo 内 skill

npx skills add ioteverythin/OpenDocs --list

SKILL.md

Frontmatter

{
    "name": "opendocs",
    "metadata": {
        "version": "1.0.0"
    },
    "description": "Generates multi-format documentation (Word, PDF, PPTX, Markdown blog post, JIRA ticket, FAQ, changelog, LaTeX, social snippet, architecture diagram) from a GitHub README, npm package, local Markdown file, Jupyter Notebook, or a folder of .md\/.ipynb files. Use when a user asks to \"generate docs\", \"convert the README\", \"create a Word doc from the repo\", \"export to PDF\", or any variant of turning existing content into formatted documentation.\n",
    "allowed-tools": "Bash, Read",
    "user-invocable": true
}

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/