markdown-pdf-export 0.0.0-stage → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Mat
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,92 @@
1
- # Temporary Holding Version
1
+ # Markdown PDF Export
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ [![Version](https://img.shields.io/github/v/release/matinfo/markdown-pdf-export?label=version&color=blue)](https://github.com/matinfo/markdown-pdf-export/releases)
4
+ [![Publish](https://github.com/matinfo/markdown-pdf-export/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/matinfo/markdown-pdf-export/actions/workflows/npm-publish.yml)
5
+ [![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
6
+
7
+ Turn Markdown files into clean PDFs from VS Code, Zed, Cursor, Claude or any AI assistant, or from
8
+ the command line.
9
+
10
+ Full documentation: <https://matinfo.github.io/markdown-pdf-export/>
11
+
12
+ ![Studio: page style, fonts, paper, header and footer on the left, a live preview of the PDF on the right](docs/public/img/studio.png)
13
+
14
+ ## Get started
15
+
16
+ You need:
17
+
18
+ - **Node.js 20 or newer** (it comes with `npx`).
19
+ - **Google Chrome or Microsoft Edge.** No Chromium browser? Run
20
+ `npx -y markdown-pdf-export install-browser` once (about 200 MB).
21
+
22
+ Then run this line in a terminal:
23
+
24
+ ```sh
25
+ npx -y markdown-pdf-export studio
26
+ ```
27
+
28
+ Studio opens in your browser. Pick a page style, fonts, paper size, header and footer, and watch the
29
+ real PDF update as you go. Click **Save**, then **Add to my editor**, and you are ready to export.
30
+
31
+ There is nothing to install first: `npx` downloads the package on first use and reuses it after.
32
+ Prefer the terminal? Run `npx -y markdown-pdf-export` with no arguments for a small menu.
33
+
34
+ More: [Get started](https://matinfo.github.io/markdown-pdf-export/start) ·
35
+ [Studio](https://matinfo.github.io/markdown-pdf-export/studio) ·
36
+ [Design online, no install](https://matinfo.github.io/markdown-pdf-export/online)
37
+
38
+ ## Export a file
39
+
40
+ | Where | How |
41
+ |---|---|
42
+ | Your editor | Run the task *Markdown: Export to PDF* on the open file |
43
+ | AI assistant | Ask: "Export this file to PDF" |
44
+ | Terminal | `npx -y markdown-pdf-export report.md` |
45
+
46
+ The PDF is saved next to the Markdown file. To add the task or the assistant tool by hand, run
47
+ `npx -y markdown-pdf-export setup`, or see
48
+ [Editors](https://matinfo.github.io/markdown-pdf-export/editors).
49
+
50
+ ## What you get
51
+
52
+ - Five page styles: Clean, Report, Academic, Compact and Technical.
53
+ - Headers and footers with the title, page numbers, the date and your logo.
54
+ - Coloured code blocks, with a choice of colour themes.
55
+ - Maths with KaTeX: `$inline$` and `$$display$$`.
56
+ - A contents list from a `[[toc]]` marker, with links to each heading.
57
+ - Settings for one document in its front matter.
58
+ - One settings file used by every editor, the assistant and the terminal.
59
+
60
+ ## Go further
61
+
62
+ - [Advanced topics](https://matinfo.github.io/markdown-pdf-export/advanced/): a one-page map of everything below.
63
+ - [Settings file](https://matinfo.github.io/markdown-pdf-export/advanced/settings-file): where it lives and how files are combined.
64
+ - [Per-document settings](https://matinfo.github.io/markdown-pdf-export/advanced/per-document): change one document with front matter.
65
+ - [Header and footer](https://matinfo.github.io/markdown-pdf-export/advanced/header-footer): zones, logos, page numbers and dates.
66
+ - [Styling](https://matinfo.github.io/markdown-pdf-export/advanced/styling): your own CSS, fonts and code colours.
67
+ - [Content](https://matinfo.github.io/markdown-pdf-export/advanced/content): maths, contents list, images and page breaks.
68
+ - [Command line](https://matinfo.github.io/markdown-pdf-export/advanced/cli): every command and option.
69
+ - [Assistant tools](https://matinfo.github.io/markdown-pdf-export/advanced/assistant-tools): the MCP server and its two tools.
70
+ - [Browser](https://matinfo.github.io/markdown-pdf-export/advanced/browser): which browser is used and how to pick another.
71
+ - [Recipes](https://matinfo.github.io/markdown-pdf-export/advanced/recipes): ready-made setups for common jobs.
72
+ - [Settings reference](https://matinfo.github.io/markdown-pdf-export/reference/settings): every setting.
73
+ - [Placeholders reference](https://matinfo.github.io/markdown-pdf-export/reference/placeholders): `{page}`, `{title}`, `{date}` and more.
74
+
75
+ ## Help
76
+
77
+ Check the browser and your settings in one step:
78
+
79
+ ```sh
80
+ npx -y markdown-pdf-export doctor
81
+ ```
82
+
83
+ You can also ask the assistant: "Run doctor_markdown_pdf". For common problems, see
84
+ [Help](https://matinfo.github.io/markdown-pdf-export/help).
85
+
86
+ ## Contributing
87
+
88
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, tests and how the project is built.
89
+
90
+ ## Licence
91
+
92
+ MIT. See [LICENSE](LICENSE).