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

Update documentation for readability #140

Merged
merged 20 commits into from
Aug 22, 2021
Merged
Changes from 1 commit
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
74 changes: 42 additions & 32 deletions website/docs/introduction/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,57 @@

### This is a stub page!

Marp provides **[CLI][marp cli]** and **[VS Code extension][marp for vs code]** as the official toolset. Get started authoring presentation now by installing either of them.
There are two ways to use Marp, through a command-line interface (**[Marp CLI][marp cli]**) or through a graphical user interface (**[VS Code extension][marp for vs code]**). To start authoring presentations, you must install either the CLI or the VS Code exension.

## [Marp for VS Code]
## Should I use the Marp CLI or Marp for VS Code?

### Basic Comparison

| | Marp for VS Code | Marp CLI |
|-------------------------: |:------------------: |:---------------------: |
| Editor | VS Code | Any editor |
| Live Preview | Yes | No |
| Export Method | Click to export | Command Line |
| Use plugins? | No | Yes |


### Marp for VS Code

If you are not familiar with the command line, use the VS Code extension without hesitation! All of the basic Marp features are available in Marp for VS Code.

Even if you are CLI savvy, you may prefer to author presentations through Marp for VS Code. VS Code has many convenient features for authoring a slide deck, including Markdown syntax lookup and live preview.

### Marp CLI

Using Marp CLI is suited for following:

- Authoring Markdown and theme CSS with your favorite editor (such as vim)
- Batch processing
- Combination with other tools (through piping and redirection)
- Continuous Integration (CI)
- Server-side conversion
- Set advanced configuration of Marp
- Use Marp in Node.js project
- Use Marp / Marpit / markdown-it plugins
- Use the other Marpit flavored engine

## Installing [Marp for VS Code]

1. Install [Visual Studio Code].
2. Install [Marp for VS Code] extension.
3. Create and open new Markdown file (with `.md` extension).
4. Execute `Toggle Marp feature for current Markdown` command from Marp icon in editor actions (toolbar). This command will add the front-matter definition like this:
2. Install the [Marp for VS Code] extension.
3. Create and open a new Markdown file (with `.md` extension).
4. Select the `Toggle Marp feature for current Markdown` command from the Marp icon in editor actions (toolbar). This command will add Marp to the front-matter of your Markdown file:
```markdown
---
marp: true
---
```
5. Open VS Code Markdown preview, and get starting to write presentation!
5. Open VS Code Markdown preview, and start writing your presentation!

[visual studio code]: https://code.visualstudio.com/
[marp for vs code]: https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode

## [Marp CLI]
## Installing [Marp CLI]

[marp cli]: https://github.com/marp-team/marp-cli

Expand All @@ -38,7 +70,7 @@ scoop install marp

### [Node.js](https://nodejs.org/)

If you have installed Node.js >= 12, you can try one-shot conversion without install powered by `npx` (`npm exec`).
If you have installed Node.js >= 12, you can try one-shot conversion without installing powered by `npx` (`npm exec`).

```bash
npx @marp-team/marp-cli@latest markdown.md
Expand All @@ -56,11 +88,11 @@ yarn add --dev @marp-team/marp-cli
yarn exec markdown.md
```

[You can also install `marp` command to globally](https://github.com/marp-team/marp-cli#global-installation) but _not recommended_.
[You can also install the `marp` command globally](https://github.com/marp-team/marp-cli#global-installation), but it is _not recommended_.

#### Standalone binary

[➡️ Download the latest standalone binary from GitHub release page...][standalone binary]
[➡️ Download the latest standalone binary from the GitHub release page...][standalone binary]

[standalone binary]: https://github.com/marp-team/marp-cli/releases

Expand All @@ -69,25 +101,3 @@ yarn exec markdown.md
[➡️ Check out the overview of an official container in Docker Hub...][docker]

[docker]: https://hub.docker.com/r/marpteam/marp-cli/

## Which one to choose

### Marp for VS Code

If you are not familiar with command line, choose VS Code extension without hesitation! You can use basic Marp features in GUI by just using Marp for VS Code.

Even if you are CLI savvy, authoring the presentation through Marp for VS Code would become a good choice. There are useful real-time preview and Marp Markdown language services, so you would get a great experience to create slide deck.

### Marp CLI

Using Marp CLI is suited for following:

- Authoring Markdown and theme CSS with your favorite editor (such as vim)
- Batch processing
- Combination with other tools (through piping and redirection)
- Continous integration (CI)
- Server-side conversion
- Set advanced configuration of Marp
- Use Marp in Node.js project
- Use Marp / Marpit / markdown-it plugins
- Use the other Marpit flavored engine