opendocs
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.
Best use case
opendocs is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
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.
Teams using opendocs should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/opendocs/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How opendocs Compares
| Feature / Agent | opendocs | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
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.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# 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 ```bash pip install opendocs ``` ## Core Command ```bash 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 ```bash # 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/`
Related Skills
workspace-surface-audit
Audit the active repo, MCP servers, plugins, connectors, env surfaces, and harness setup, then recommend the highest-value ECC-native skills, hooks, agents, and operator workflows. Use when the user wants help setting up Claude Code or understanding what capabilities are actually available in their environment.
ui-demo
Record polished UI demo videos using Playwright. Use when the user asks to create a demo, walkthrough, screen recording, or tutorial video of a web application. Produces WebM videos with visible cursor, natural pacing, and professional feel.
token-budget-advisor
Offers the user an informed choice about how much response depth to consume before answering. Use this skill when the user explicitly wants to control response length, depth, or token budget. TRIGGER when: "token budget", "token count", "token usage", "token limit", "response length", "answer depth", "short version", "brief answer", "detailed answer", "exhaustive answer", "respuesta corta vs larga", "cuántos tokens", "ahorrar tokens", "responde al 50%", "dame la versión corta", "quiero controlar cuánto usas", or clear variants where the user is explicitly asking to control answer size or depth. DO NOT TRIGGER when: user has already specified a level in the current session (maintain it), the request is clearly a one-word answer, or "token" refers to auth/session/payment tokens rather than response size.
skill-comply
Visualize whether skills, rules, and agent definitions are actually followed — auto-generates scenarios at 3 prompt strictness levels, runs agents, classifies behavioral sequences, and reports compliance rates with full tool call timelines
santa-method
Multi-agent adversarial verification with convergence loop. Two independent review agents must both pass before output ships.
safety-guard
Use this skill to prevent destructive operations when working on production systems or running agents autonomously.
repo-scan
Cross-stack source code asset audit — classifies every file, detects embedded third-party libraries, and delivers actionable four-level verdicts per module with interactive HTML reports.
project-flow-ops
Operate execution flow across GitHub and Linear by triaging issues and pull requests, linking active work, and keeping GitHub public-facing while Linear remains the internal execution layer. Use when the user wants backlog control, PR triage, or GitHub-to-Linear coordination.
product-lens
Use this skill to validate the "why" before building, run product diagnostics, and pressure-test product direction before the request becomes an implementation contract.
openclaw-persona-forge
为 OpenClaw AI Agent 锻造完整的龙虾灵魂方案。根据用户偏好或随机抽卡， 输出身份定位、灵魂描述(SOUL.md)、角色化底线规则、名字和头像生图提示词。 如当前环境提供已审核的生图 skill，可自动生成统一风格头像图片。 当用户需要创建、设计或定制 OpenClaw 龙虾灵魂时使用。 不适用于：微调已有 SOUL.md、非 OpenClaw 平台的角色设计、纯工具型无性格 Agent。 触发词：龙虾灵魂、虾魂、OpenClaw 灵魂、养虾灵魂、龙虾角色、龙虾定位、 龙虾剧本杀角色、龙虾游戏角色、龙虾 NPC、龙虾性格、龙虾背景故事、 lobster soul、lobster character、抽卡、随机龙虾、龙虾 SOUL、gacha。
manim-video
Build reusable Manim explainers for technical concepts, graphs, system diagrams, and product walkthroughs, then hand off to the wider ECC video stack if needed. Use when the user wants a clean animated explainer rather than a generic talking-head script.
laravel-plugin-discovery
Discover and evaluate Laravel packages via LaraPlugins.io MCP. Use when the user wants to find plugins, check package health, or assess Laravel/PHP compatibility.