Agent skill

Opendocs

by ioteverythin in ioteverythin/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…

MITAuto-check: notesDocuments & Office

Install Opendocs

skills CLI
$ npx skills add ioteverythin/OpenDocs --skill opendocs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install ioteverythin/OpenDocs opendocs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/ioteverythin/OpenDocs.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/opendocs .claude/skills/opendocs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
opendocs
GitHub stars
233
Token cost
~746 tokens
SKILL.md length
202 words
Files
1
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

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…

  • A user asks to generate docs
  • SKILL.md covers Install, Core Command, Sources and Key Options, plus 3 more sections
  • Calls pip; reaches github.com; needs GITHUB_TOKEN and OPENAI_API_KEY
  • Convert the README

What it does

Opendocs is an agent skill from ioteverythin/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.

Its SKILL.md is about 750 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Documents & Office, covering Jupyter notebooks, Blog and article writing and PowerPoint presentations. It works with Jupyter, npm, GitHub and Microsoft PowerPoint. The licence is MIT.

When your agent uses it

  • A user asks to generate docs
  • Convert the README
  • Create a Word doc from the repo
  • Any variant of turning existing content into formatted documentation

Example prompts

  • “generate docs”
  • “convert the README”
  • “create a Word doc from the repo”
  • “/opendocs”

Requirements

  • Python 3
  • A credential in GITHUB_TOKEN
  • A credential in OPENAI_API_KEY
  • Pre-approved tools (allowed-tools): Bash, Read

What it can do on your machine

Read from SKILL.md and the folder at commit 0aa5049. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Bash
    • Read

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • pip

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • github.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • GITHUB_TOKEN
    • OPENAI_API_KEY

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Opendocs loads about 746 tokens when it runs. Until then it costs about 113 tokens; SKILL.md has 202 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~113
When it runs · the whole SKILL.md, loaded when a task matches
~746

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
    allowed-tools: Bash, Read

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from ioteverythin/OpenDocs at commit 0aa5049, republished under its MIT licence (© ioteverythin). 202 words, ~746 tokens.

Download SKILL.mdSave it as .claude/skills/opendocs/SKILL.md (or your agent's skills folder).
name
opendocs
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.
allowed-tools
Bash, Read
user-invocable
true
metadata.version
1.0.0

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 typeExample
GitHub URLopendocs generate https://github.com/owner/repo
npm packageopendocs generate npm:axios
Local fileopendocs generate ./README.md --local
Jupyter Notebookopendocs generate ./notebook.ipynb --local
Folder of .md/.ipynbopendocs generate ./docs/

Key Options

OptionDefaultDescription
-f, --formatallOutput format: word, pdf, pptx, blog, jira, changelog, latex, onepager, social, faq, architecture, all
-o, --output./outputDirectory for generated files
--localoffTreat SOURCE as a local path
--token$GITHUB_TOKENGitHub token for private repos
--themecorporateColor theme: corporate, ocean, sunset, forest, minimal
--modebasicbasic (fast, no API key) or llm (AI-enhanced, needs --api-key)
--api-key$OPENAI_API_KEYAPI 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/

© ioteverythin, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/opendocs of ioteverythin/OpenDocs.

Open the folder on GitHubat commit 0aa5049

Compare with similar skills

Opendocs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Opendocs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Opendocs this skillioteverythin/OpenDocs233—~746Automated safety check: NotesMIT
Markdown Exporterbowenliang123/markdown-exporter2721 repos~5.3kAutomated safety check: PassApache-2.0
Ambiguity Reportlawve-ai/awesome-legal-skills842—~4.6kAutomated safety check: PassApache-2.0
Lexoid CLIoidlabs-com/Lexoid109—~2kAutomated safety check: NotesApache-2.0
Lexoid Pythonoidlabs-com/Lexoid109—~3.5kAutomated safety check: NotesApache-2.0
Doclingzhuzhaoyun/Molio433—~2.6kAutomated safety check: PassCustom licence

Similar skills

  • Markdown Exporter

    bowenliang123/markdown-exporter

    Convert Markdown text to DOCX, PPTX, XLSX, PDF, PNG, SVG, HTML, IPYNB, MD, CSV, JSON, JSONL, XML files, and extract code blocks in Markdown to Python, Bash,JS and etc files.

    272 GitHub starsUsed in 1 repo~5.3k tokens
    Documents & OfficeAuto-check passed
  • Ambiguity Report

    lawve-ai/awesome-legal-skills

    Turn an interpretive-ambiguity audit of a legal text — contract, statute, regulation, or judicial opinion — into a polished deliverable.

    842 GitHub stars~4.6k tokensUpdated 6 days ago
    Documents & OfficeAuto-check passed
  • Lexoid CLI

    oidlabs-com/Lexoid

    Parse and convert documents (PDFs, images, web pages, DOCX/XLSX/PPTX, audio) from the terminal using the lexoid CLI.

    109 GitHub stars~2k tokensUpdated yesterday
    Documents & OfficeAuto-check: notes
  • Lexoid Python

    oidlabs-com/Lexoid

    Parse and convert documents (PDFs, images, web pages, DOCX/XLSX/PPTX, audio) inside a Python program using the lexoid library.

    109 GitHub stars~3.5k tokensUpdated yesterday
    Documents & OfficeAuto-check: notes
  • Docling

    zhuzhaoyun/Molio

    PRIMARY skill for converting .pdf, .docx, .pptx, .xlsx, .doc, .ppt, .xls, images, and audio/video files (.mp3, .wav, .m4a, .mp4, .mov, etc.) to Markdown.

    433 GitHub stars~2.6k tokensUpdated today
    Documents & OfficeAuto-check passed
  • Thu Thesis

    LeoYeAI/openclaw-master-skills

    清华大学毕业论文 Word → PDF 一键格式规范化工具。输入任意 Word (.docx) 格式的清华毕业论文,自动转换为符合清华 thuthesis 官方 LaTeX 模板规范的高质量 PDF。适用于所有清华学位论文(MBA/学硕/专硕),一条命令搞定。功能:自动提取章节结构、中英文摘要、参考文献(自动生成 BibTeX)、图片(含…

    2.2k GitHub stars~4k tokensUpdated 2 mo ago
    Documents & OfficeAuto-check passed

Questions about Opendocs

What does Opendocs 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…. Opendocs is an agent skill from ioteverythin/OpenDocs.ipynb files.

When should I use Opendocs?

Opendocs fits situations like: A user asks to generate docs; convert the README; create a Word doc from the repo; any variant of turning existing content into formatted documentation.

How do I install Opendocs in Claude Code?

Run `npx skills add ioteverythin/OpenDocs --skill opendocs -a claude-code`. Or copy the skill folder (skills/opendocs in ioteverythin/OpenDocs) into .claude/skills/opendocs in your project. Claude Code loads it when a task matches its description.

How do I install Opendocs in Codex?

Run `npx skills add ioteverythin/OpenDocs --skill opendocs -a codex`. Or copy the skill folder (skills/opendocs in ioteverythin/OpenDocs) into .agents/skills/opendocs in your project. Codex loads it when a task matches its description.

Can I use Opendocs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ioteverythin/OpenDocs --skill opendocs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/opendocs, .gemini/skills/opendocs, .github/skills/opendocs and .opencode/skills/opendocs in your project.

What does Opendocs need to run?

Going by SKILL.md and its folder, Opendocs needs the command-line tools its instructions call (pip) and credentials named GITHUB_TOKEN and OPENAI_API_KEY. Our summary lists: Python 3; A credential in GITHUB_TOKEN; A credential in OPENAI_API_KEY. Its frontmatter pre-approves these tools: Bash, Read.

Does Opendocs access the network?

SKILL.md names 1 domain. In commands or code: github.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Opendocs safe to install?

Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Opendocs use?

Opendocs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Opendocs use?

About 746 tokens (SKILL.md is roughly 3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Opendocs?

Skills that share tags, products or a category with Opendocs: Markdown Exporter (bowenliang123/markdown-exporter, 272 stars), Ambiguity Report (lawve-ai/awesome-legal-skills, 842 stars), Lexoid CLI (oidlabs-com/Lexoid, 109 stars) and Lexoid Python (oidlabs-com/Lexoid, 109 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Opendocs?

ioteverythin (a GitHub organization) maintains it in ioteverythin/OpenDocs, which has 233 GitHub stars. The repository was last updated on August 16, 2026.

Source: ioteverythin/OpenDocs on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.