From aef418506bfdba680b1dd969c124d2deba8587da Mon Sep 17 00:00:00 2001 From: Jean-Luc Makiola Date: Mon, 4 May 2026 20:10:01 +0200 Subject: [PATCH] docs: README + MIT LICENSE --- LICENSE | 21 +++++++++++++++++++++ README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c6dd179 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Jean-Luc Makiola + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..afdab08 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# claude-md-to-pdf + +A Claude Code plugin marketplace exposing the **md-to-pdf** skill — natural-language Markdown→PDF conversion using [`md-to-pdf`](https://www.npmjs.com/package/md-to-pdf). + +## What it does + +When you say things like *"exportier mal das PDF"*, *"regenerate the PDF"*, or *"convert this markdown to pdf"*, the skill picks up the relevant `.md`, finds the right style config, and runs `npx md-to-pdf`. No slash command required. + +## Install + +In Claude Code, on each device: + +``` +/plugin marketplace add https://gitea./jlmak/claude-md-to-pdf +/plugin install md-to-pdf@claude-md-to-pdf +``` + +(Replace `gitea.` with your Gitea host. The repo can also be installed from a local clone — see "Local install" below.) + +## Requirements + +- Node.js with `npx` on `PATH` (the skill calls `npx --yes md-to-pdf`). + +## How style is chosen + +The skill walks upward from the source `.md` file looking for a `.md-to-pdf.config.js`. If found, it's used. Otherwise the bundled default — A4, 15/12mm margins, 5pt fixed-layout tables, system sans-serif at 11pt — is used. The bundled default lives at: + +``` +plugins/md-to-pdf/skills/md-to-pdf/default.config.js +``` + +## Local install (no Gitea remote yet) + +``` +/plugin marketplace add ~/Development/claude-md-to-pdf +/plugin install md-to-pdf@claude-md-to-pdf +``` + +## License + +MIT — see `LICENSE`.