|
1 | 1 | # @marp-team/marp-cli
|
2 | 2 |
|
3 |
| -[](https://circleci.com/gh/marp-team/marp-cli/) |
4 |
| -[](https://github.com/marp-team/marp-cli/actions?query=workflow%3A%22Test+for+Windows%22+branch%3Amaster) |
5 |
| -[](https://codecov.io/gh/marp-team/marp-cli) |
| 3 | +[](https://circleci.com/gh/marp-team/marp-cli/) |
| 4 | +[](https://github.com/marp-team/marp-cli/actions?query=workflow%3A%22Test+for+Windows%22+branch%3Amain) |
| 5 | +[](https://codecov.io/gh/marp-team/marp-cli) |
6 | 6 | [](https://www.npmjs.com/package/@marp-team/marp-cli)
|
7 | 7 | [](https://hub.docker.com/r/marpteam/marp-cli/)
|
8 | 8 | [](./LICENSE)
|
|
12 | 12 | It can convert Marp / Marpit Markdown files into static HTML / CSS, PDF, PowerPoint document, and image(s) easily.
|
13 | 13 |
|
14 | 14 | <p align="center">
|
15 |
| - <img src="https://raw.githubusercontent.com/marp-team/marp-cli/master/docs/images/marp-cli.gif" /> |
| 15 | + <img src="https://raw.githubusercontent.com/marp-team/marp-cli/main/docs/images/marp-cli.gif" /> |
16 | 16 | </p>
|
17 | 17 |
|
18 | 18 | ## Try it now!
|
@@ -137,7 +137,7 @@ marp slide-deck.md -o converted.pptx
|
137 | 137 | A created PPTX includes rendered Marp slide pages and the support of [Marpit presenter notes](https://marpit.marp.app/usage?id=presenter-notes). It can open with PowerPoint, Keynote, Google Slides, LibreOffice Impress, and so on...
|
138 | 138 |
|
139 | 139 | <p align="center">
|
140 |
| - <img src="https://raw.githubusercontent.com/marp-team/marp-cli/master/docs/images/pptx.png" height="300" /> |
| 140 | + <img src="https://raw.githubusercontent.com/marp-team/marp-cli/main/docs/images/pptx.png" height="300" /> |
141 | 141 | </p>
|
142 | 142 |
|
143 | 143 | > :information_source: A converted PPTX consists of pre-rendered images. Please note that contents would not be able to modify or re-use in PowerPoint.
|
@@ -195,7 +195,7 @@ While you are opening the converted HTML in browser, it would refresh the opened
|
195 | 195 | Server mode supports on-demand conversion by HTTP request. We require to pass `--server` (`-s`) option and a directory to serve.
|
196 | 196 |
|
197 | 197 | <p align="center">
|
198 |
| - <img src="https://raw.githubusercontent.com/marp-team/marp-cli/master/docs/images/server-mode.gif" /> |
| 198 | + <img src="https://raw.githubusercontent.com/marp-team/marp-cli/main/docs/images/server-mode.gif" /> |
199 | 199 | </p>
|
200 | 200 |
|
201 | 201 | In this mode, the converted file outputs as the result of accessing to server, and not to disk. You can set the server port by setting the environment variable `PORT`, for example `PORT=5000 marp -s ./slides` would listen on port number 5000.
|
@@ -293,7 +293,7 @@ Marp CLI prefers CLI option to global directives. You can override metadata valu
|
293 | 293 |
|
294 | 294 | ### Override theme
|
295 | 295 |
|
296 |
| -You can override theme you want to use by `--theme` option. For example to use [Gaia](https://github.com/marp-team/marp-core/tree/master/themes#gaia) built-in theme in Marp Core: |
| 296 | +You can override theme you want to use by `--theme` option. For example to use [Gaia](https://github.com/marp-team/marp-core/tree/main/themes#gaia) built-in theme in Marp Core: |
297 | 297 |
|
298 | 298 | ```bash
|
299 | 299 | marp --theme gaia
|
@@ -495,7 +495,7 @@ marpCli(['test.md', '--pdf'])
|
495 | 495 |
|
496 | 496 | ### Error handling
|
497 | 497 |
|
498 |
| -We have exported [`CLIError` class and `CLIErrorCode` enum](https://github.com/marp-team/marp-cli/blob/master/src/error.ts) from `@marp-team/marp-cli`, to allow handling for specific errors that have already known by Marp CLI. |
| 498 | +We have exported [`CLIError` class and `CLIErrorCode` enum](https://github.com/marp-team/marp-cli/blob/main/src/error.ts) from `@marp-team/marp-cli`, to allow handling for specific errors that have already known by Marp CLI. |
499 | 499 |
|
500 | 500 | If `CLIError` instance was thrown, you can identify the reason why CLI throwed error by checking `errorCode` member.
|
501 | 501 |
|
|
0 commit comments