Skip to content

Commit

Permalink
Merge pull request #134 from marp-team/fix-broken-emoji-on-docs
Browse files Browse the repository at this point in the history
Fix broken emoji on docs
  • Loading branch information
yhatt authored Feb 13, 2019
2 parents c2f387d + edc0aa9 commit 2cffe17
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 17 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
### Fixed

- Use re-exported markdown-it Token from state ([#132](https://github.com/marp-team/marpit/pull/132))
- Fix broken emoji on docs ([#134](https://github.com/marp-team/marpit/pull/134))

### Changed

Expand Down
20 changes: 10 additions & 10 deletions docs/image-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

Marpit has extended Markdown image syntax `![](image.jpg)` to be helpful creating beautiful slides.

| Features | Inline image | Slide BG | Advanced BG |
| :--------------------------------: | :----------------------: | :----------------------: | :----------------: |
| [Resizing by keywords][resizing] | `auto` only | :heavy_check_mark: | :heavy_check_mark: |
| [Resizing by percentage][resizing] | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: |
| [Resizing by length][resizing] | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [Image filters][filters] | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
| [Background color][bgcolor] | - | :heavy_check_mark: | :heavy_check_mark: |
| [Multiple backgrounds][multiple] | - | :heavy_multiplication_x: | :heavy_check_mark: |
| [Split backgrounds][split] | - | :heavy_multiplication_x: | :heavy_check_mark: |
| Features | Inline image | Slide BG | Advanced BG |
| :--------------------------------: | :----------: | :------: | :---------: |
| [Resizing by keywords][resizing] | `auto` only | | |
| [Resizing by percentage][resizing] | | | |
| [Resizing by length][resizing] | | | |
| [Image filters][filters] | || |
| [Background color][bgcolor] | - | | |
| [Multiple backgrounds][multiple] | - | | |
| [Split backgrounds][split] | - | | |

[resizing]: #resizing-image
[filters]: #image-filters
Expand Down Expand Up @@ -123,7 +123,7 @@ It is same as defining [`<!-- _backgroundColor: "#fff" -->` spot directive](/dir

## Advanced backgrounds

!> :triangular_ruler: It will work only in experimental [inline SVG slide](/inline-svg).
!> 📐 It will work only in experimental [inline SVG slide](/inline-svg).

The advanced backgrounds support [multiple backgrounds][multiple], [split backgrounds][split], and [image filters for background][filters].

Expand Down
2 changes: 1 addition & 1 deletion docs/inline-svg.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Inline SVG slide _(experimental)_

!> :triangular_ruler: This feature is experimental because of a strange rendering in some browsers.
!> 📐 This feature is experimental because of a strange rendering in some browsers.

When you set [`inlineSVG: true` in Marpit constructor option](/usage#triangular_ruler-inline-svg-slide), each `<section>` elements are wrapped with inline SVG.

Expand Down
6 changes: 3 additions & 3 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ In fact, this framework is created for using as the base of [a core converter][m

## Features

### [:pencil: Marpit Markdown](/markdown) {docsify-ignore}
### [📝 Marpit Markdown](/markdown) {docsify-ignore}

We have extended several features into [markdown-it](https://github.com/markdown-it/markdown-it) parser to support writing awesome slides, such as [_Directives_](/directives) and [_Slide backgrounds_](/image-syntax#slide-backgrounds). Additional syntaxes place importance on a compatibility with general Markdown documents.

### [:art: Theme CSS by clean markup](/theme-css) {docsify-ignore}
### [🎨 Theme CSS by clean markup](/theme-css) {docsify-ignore}

Marpit has the CSS theming system that can design slides everything. Unlike other slide frameworks, there are not any predefined classes and mixins. You have only to focus styling HTML elements by pure CSS. Marpit would take care of the selected theme's necessary conversion.

### [:triangular_ruler: Inline SVG slide <i>(Experimental)</i>](/inline-svg) {docsify-ignore}
### [📐 Inline SVG slide <i>(Experimental)</i>](/inline-svg) {docsify-ignore}

Optionally `<svg>` element can use as the container of each slide page. It can be realized the pixel-perfect scaling of the slide only by CSS, so handling slides in integrated apps become simplified. The isolated layer made by `<foreignObject>` can provide [_advanced backgrounds_](/image-syntax#advanced-backgrounds) for the slide with keeping the original Markdown DOM structure.

Expand Down
6 changes: 3 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ By passing object of options, you can customize the behavior of Marpit instance

_**[See all options at JSDoc](https://marpit-api.marp.app/marpit)** to details._ Here we will introduce useful recipes.

#### :pencil: [markdown-it](https://github.com/markdown-it/markdown-it) parser setting
#### 📝 [markdown-it](https://github.com/markdown-it/markdown-it) parser setting

You can customize the behavior of Markdown parser by `markdown` option. It will pass to [markdown-it initializer](https://github.com/markdown-it/markdown-it#init-with-presets-and-options) as it is.

Expand All @@ -32,7 +32,7 @@ const marpit = new Marpit({
})
```

#### :package: Customize container elements
#### 📦 Customize container elements

You can customize container HTML elements too. These settings are using to scope the converted CSS. [`Element` class](https://marpit-api.marp.app/element) helps to specify container(s).

Expand Down Expand Up @@ -63,7 +63,7 @@ It would render elements like this:

The default container is [`<div class="marpit">`](https://marpit-api.marp.app/module-element.html#.marpitContainer), and no slide containers (render only `<section>`). If you may not use any containers and CSS scoping, please set `container` option as `false`.

#### :triangular_ruler: Inline SVG slide
#### 📐 Inline SVG slide

Turn on the _(experimental)_ [inline SVG slide](/inline-svg).

Expand Down

0 comments on commit 2cffe17

Please sign in to comment.