Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark preview window as stable #348

Merged
merged 3 commits into from
May 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
### Changed

- Upgrade dependent packages to the latest version ([#347](https://github.com/marp-team/marp-cli/pull/347))
- Mark preview window as stable ([#348](https://github.com/marp-team/marp-cli/pull/348))

## v1.0.3 - 2021-05-09

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Marp CLI server will provide the list of served files by default, but you can pl

Place Markdown named `index.md` or `PITCHME.md` ([GitPitch style](https://gitpitch.com/docs/getting-started/pitchme/)) to served directory. It would be redirected just accessing to `http://localhost:8080/`.

### Preview window (_EXPERIMENTAL:_ `--preview` / `-p`)
### Preview window (`--preview` / `-p`)

When conversions were executed together with `--preview` (`-p`) option, Marp CLI will open preview window(s) to check the converted result immediately.

Expand Down Expand Up @@ -436,7 +436,7 @@ If you want to prevent looking up a configuration file, you can pass `--no-confi
| `options` | object | | The base options for the constructor of engine |
| `output` | string | `--output` `-o` | Output file path (or directory when input-dir is passed) |
| `pdf` | boolean | `--pdf` | Convert slide deck into PDF |
| `preview` | boolean | `--preview` `-p` | Open preview window _(EXPERIMENTAL)_ |
| `preview` | boolean | `--preview` `-p` | Open preview window |
| `server` | boolean | `--server` `-s` | Enable server mode |
| `template` | `bare` \| `bespoke` | `--template` | Choose template (`bespoke` by default) |
| `theme` | string | `--theme` | Override theme by name or CSS file |
Expand Down
4 changes: 2 additions & 2 deletions src/marp-cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export const marpCli = async (
},
preview: {
alias: 'p',
describe: 'Open preview window (EXPERIMENTAL)',
describe: 'Open preview window',
hidden: !!process.env.IS_DOCKER,
group: OptionGroup.Basic,
type: 'boolean',
Expand Down Expand Up @@ -326,7 +326,7 @@ export const marpCli = async (
preview.on('exit', () => res(0))
preview.on('opening', (location: string) => {
const loc = location.substr(0, 50)
const msg = `[Preview] (EXPERIMENTAL) Opening ${loc}...`
const msg = `[Preview] Opening ${loc}...`
cli.info(chalk.cyan(msg))
})

Expand Down