{"id":34713217,"url":"https://github.com/brege/oshea","last_synced_at":"2026-03-17T06:03:07.575Z","repository":{"id":294974233,"uuid":"986003710","full_name":"brege/oshea","owner":"brege","description":"A Node.JS Markdown to PDF converter and extensible doctype plugin system","archived":false,"fork":false,"pushed_at":"2026-02-22T07:06:17.000Z","size":5110,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-22T13:27:00.780Z","etag":null,"topics":["end-to-end-testing","javascript","markdown","md-to-pdf","nodejs","plugin-manager","yaml"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brege.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-19T00:42:00.000Z","updated_at":"2026-02-22T07:06:20.000Z","dependencies_parsed_at":"2025-08-03T12:28:02.941Z","dependency_job_id":"d847e584-891d-460b-b830-7f6f45f43cc2","html_url":"https://github.com/brege/oshea","commit_stats":null,"previous_names":["brege/md-to-pdf","brege/oshea"],"tags_count":83,"template":false,"template_full_name":null,"purl":"pkg:github/brege/oshea","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Foshea","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Foshea/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Foshea/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Foshea/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brege","download_url":"https://codeload.github.com/brege/oshea/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brege%2Foshea/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29741144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T07:44:07.782Z","status":"ssl_error","status_checked_at":"2026-02-23T07:44:07.432Z","response_time":90,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["end-to-end-testing","javascript","markdown","md-to-pdf","nodejs","plugin-manager","yaml"],"created_at":"2025-12-25T00:50:42.394Z","updated_at":"2026-02-23T09:54:48.194Z","avatar_url":"https://github.com/brege.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# oshea - Markdown to PDF Converter\n\nA [Node.js](https://nodejs.org/) command-line tool that transforms [Markdown](https://daringfireball.net/projects/markdown/) files into beautifully styled PDFs. It features a powerful, extensible plugin system making it incredibly versatile for creating anything from CVs and cover letters to recipe books and custom reports.\n\nBuilt on [markdown-it](https://github.com/markdown-it/markdown-it) for Markdown parsing and\n[puppeteer](https://pptr.dev/) for PDF generation.\n\n---\n\n**The rise of AI tooling has brought enormous growth to universal Markdown usage. **`oshea`** is ideal for anyone who writes in Markdown but needs polished, professional, reproducible output for resumes, reports, presentations, and more.**\n\nSee [Creating Plugins with Claude Skills](#creating-plugins-with-claude-skills) for Claude and Codex.\n\n---\n\n### Quick Start\n\nConvert a basic Markdown file to PDF\n```bash\noshea my-document.md\n```\nUse a built-in plugin for styling\n```bash\noshea my-resume.md --plugin cv\n```\nCreate a cover letter with professional formatting\n```bash\noshea my-letter.md --plugin cover-letter\n```\n\n---\n\n### Examples\n\nThis tool allows you to produce high-quality and re-usable, aesthetic documents.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ca href=\"plugins/cv\"\u003e\n      \u003cimg src=\"docs/images/screenshots/example-cv.png\" width=\"300\"\u003e\n      \u003cbr\u003e\u003cstrong\u003eCV Layout\u003c/strong\u003e\u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"plugins/cover-letter\"\u003e\n      \u003cimg src=\"docs/images/screenshots/example-cover-letter.png\" width=\"300\"\u003e\n      \u003cbr\u003e\u003cstrong\u003eCover Letter Layout\u003c/strong\u003e\u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"plugins/recipe\"\u003e\n      \u003cimg src=\"docs/images/screenshots/example-recipe.png\" width=\"300\"\u003e\n      \u003cbr\u003e\u003cstrong\u003eRecipe Layout\u003c/strong\u003e\u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ca href=\"plugins/advanced-card\"\u003e\n      \u003cimg src=\"docs/images/screenshots/advanced-business-card.png\" width=\"300\"\u003e\n      \u003cbr\u003e\u003cstrong\u003eBusiness Card\u003c/strong\u003e\u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/brege/oshea-plugins/tree/main/restaurant-menu\"\u003e\n      \u003cimg src=\"docs/images/screenshots/restaurant-menu.png\" width=\"300\"\u003e\n      \u003cbr\u003e\u003cstrong\u003eRestaurant Menu\u003c/strong\u003e\u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/brege/oshea-plugins/tree/main/d3-histogram-slide\"\u003e\n      \u003cimg src=\"docs/images/screenshots/d3-histogram-slide.png\" width=\"300\"\u003e\n      \u003cbr\u003e\u003cstrong\u003eD3.js Slide\u003c/strong\u003e\u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n---\n\n### Installation\n\n```bash\ngit clone https://github.com/brege/oshea.git\ncd oshea\nnpm install -g\n```\n\n---\n\n### Working with Plugins\n\nUse any plugin with your markdown files:\n```bash\noshea convert my-resume.md --plugin cv\n```\n\nTake a look at the [Bundled Plugins](plugins/index.md) page for more examples.\n\n**Watch mode:** `oshea` can watch for changes to your markdown and plugin files with `oshea --watch`.\n\n\u003e [!NOTE]\n\u003e The `convert` command is implicit when a markdown file is provided. For generators (like building recipe books), the distinction between `convert` and `generate` becomes important.\n\n---\n\n### Creating Custom Plugins\n\nTo customize layouts, you can archetype from existing plugins or create a new one from scratch.\n```bash\noshea plugin create --from cover-letter my-better-letter --target-dir 'my-plugins'\n```\n\nThis creates a complete plugin structure:\n```bash\nmy-plugins/my-better-letter\n├── .contract                       # schema and in-situ testing\n├── my-better-letter.config.yaml    # plugin configuration (page size, versioning, etc)\n├── my-better-letter.css            # custom CSS properties\n├── my-better-letter-example.md     # example file\n├── index.js                        # handler\n└── README.md                       # plugin description (embedded --help text)\n```\n\nThis allows for greater flexibility and re-usability. Plugins are portable and can be shared across projects.\n\n---\n\n### Creating Plugins with Claude Skills\n\nUse the skill-first workflow documented in [**docs/ai/claude-skills.md**](docs/ai/claude-skills.md).\n\nThese references compose the technical contract agents follow when creating plugins:\n* [Plugin Contract](docs/refs/plugin-contract.md)\n* [AI Interaction Specification](docs/ai/interaction-spec.md)\n* [Archetyping Walkthrough](docs/walkthroughs/archetyping-a-plugin.md)\n\n#### Validate a Plugin\n```bash\noshea plugin validate my-plugin\ncd my-plugin\noshea my-plugin-example.md\n```\n\nIterate with your agent until the plugin is satisfactory.\n\n---\n\n### Collections -- Managing Plugins\n\nThe collections manager makes it easy to manage plugins and collections of plugins.\n```bash\noshea collection add my-plugins\n# or add individual plugins\noshea plugin add my-plugins/my-better-letter\n```\n\nEnable plugins for use anywhere:\n```bash\noshea plugin enable my-plugins/my-better-letter\n# or enable entire collections\noshea collection enable my-plugins\n```\n\nThis workflow lets you maintain a development repository with a self-activating testing area while providing production copies for use anywhere.\n\n---\n\n### Documentation\n\nMany workflows and walkthroughs are available:\n\n* [Walkthrough: A Plugin's Full Lifecycle](docs/walkthroughs/full-lifecycle.md)\n* [Walkthrough: Customizing a Plugin with Archetyping](docs/walkthroughs/archetyping-a-plugin.md)\n* [Walkthrough: Updating and Syncing Plugins](docs/walkthroughs/updating-plugins.md)\n* [Walkthrough: Creating a Deck of Digital Notecards](docs/walkthroughs/generate-mobile-study-cards.md)\n\nOther guides:\n\n* [Batch Processing](docs/guides/batch-processing-guide.md) - Creating a set of PDFs from a directory of markdown files. Alternatively, the `generate` command builds a single PDF from multiple markdown files.\n* [Plugin Development Guide](docs/guides/plugin-development.md) - Manual configurations and complex workflows.\n* [Configuration Hierarchies](docs/guides/configuration-hierarchies.md) - Details on the config hierarchy and how it's used.\n\n---\n\n### Usage \u0026 Commands\n\n**Cheatsheet:** [`docs/refs/cheat-sheet.md`](docs/refs/cheat-sheet.md)\n\n**Dynamic Tab-completion**\n```bash\necho 'source \u003c(oshea completion)' \u003e\u003e ~/.bashrc\nsource ~/.bashrc\n```\n\n**Plugin Management Commands**\n```bash\noshea plugin help cv              # Plugin-specific help\noshea plugin list                 # List all plugins (add --short for brief)\noshea plugin validate my-plugin   # Validate plugin structure and tests\n```\n\n**Collection Commands**\n```bash\noshea collection list                                          # List collections\noshea collection add https://github.com/brege/oshea-plugins    # Add remote collection\noshea update                                                   # Update plugins/collections\n```\n\n---\n\n### Project Structure\n\n- [**Docs**](docs/index.md) - Documentation index and archives\n- [**Paths**](paths/index.md) - The centralized path registry used by all app and test modules\n- [**Plugins**](plugins/index.md) - Bundled plugins, and a higher level plugin overview\n- [**Scripts**](scripts/index.md) - Utility scripts\n- [**Tests**](test/index.md) - [Mocha](https://mochajs.org/)-based integration, end-to-end, and lifecycle tests.\n\n---\n\n### Development \u0026 Testing\n\n- **Config precedence:** `--config` flag \u003e user `~/.config/oshea/config.yaml` \u003e `config.example.yaml`\n- **Plugin precedence:** `--plugin` flag \u003e front matter \u003e local `*.config.yaml` \u003e default\n\n* [`test/index.md`](test/index.md)\n* [`.mocharc.js`](.mocharc.js)\n\nThis project has a rich testing framework. In addition to the in-situ tests bundled with each plugin, there are over 300 tests, ranging from unit, integration, end-to-end, and lifecycle tests, in a declarative, manifest-driven harness and factory mocking system. The best place to start is the [Test Index](test/index.md).\n\n```bash\nnpm test\nnpm test -- --group collections\n```\n\nRe-run last failures with `npm run test:last-fails`. Run tests in watch mode with `npm run test:watch`.\n\nPlugins are easy to test.\n```bash\noshea plugin validate my-plugins/my-better-letter\n```\nThis checks if your plugin is self-activating and passes basic checks.\n\n---\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrege%2Foshea","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrege%2Foshea","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrege%2Foshea/lists"}