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

Add documentation of fragmented list #152

Merged
merged 2 commits into from
Apr 9, 2019
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## [Unreleased]

### Added

- Add [documentation of fragmented list](https://marpit.marp.app/fragmented-list) ([#152](https://github.com/marp-team/marpit/pull/152))

## v0.9.2 - 2019-04-08

### Fixed
Expand Down
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
- <br>[Marpit Markdown](/markdown)
- [Directives](/directives)
- [Image syntax](/image-syntax)
- [Fragmented list](/fragmented-list)
- [Theme CSS](/theme-css)
- [Inline SVG slide](/inline-svg)

Expand Down
80 changes: 80 additions & 0 deletions docs/fragmented-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Fragmented list

Since v0.9.0, Marpit will parse lists with specific markers as the **fragmented list** for appearing contents one by one.

## For bullet list

CommonMark allows `-`, `+`, and `*` as the character of [bullet list marker](https://spec.commonmark.org/0.29/#bullet-list-marker). Marpit would parse as fragmented list if you are using `*` as the marker.

<!-- prettier-ignore-start -->

```markdown
# Bullet list

- One
- Two
- Three

---

# Fragmented list

* One
* Two
* Three
```

<!-- prettier-ignore-end -->

## For ordered list

CommonMark's [ordered list marker](https://spec.commonmark.org/0.29/#ordered-list-marker) must have `.` or `)` after digits. Marpit would parse as fragmented list if you are using `)` as the following character.

<!-- prettier-ignore-start -->

```markdown
# Ordered list

1. One
2. Two
3. Three

---

# Fragmented list

1) One
2) Two
3) Three
```

<!-- prettier-ignore-end -->

## Rendering

A structure of rendered HTML from the fragmented list is same as the regular list. It just adds `data-marpit-fragment` data attribute to list items. They would be numbered from 1 in order of recognized items.

In addition, `<section>` element of the slide that has fragmented list would be added `data-marpit-fragments` data attribute. It shows the number of fragmented list items of its slide.

The below HTML is a rendered result of [bullet list example](#for-bullet-list).

```html
<section id="1">
<h1>Bullet list</h1>
<ul>
<li>One</li>
<li>Two</li>
<li>Three</li>
</ul>
</section>
<section id="2" data-marpit-fragments="3">
<h1>Fragmented list</h1>
<ul>
<li data-marpit-fragment="1">One</li>
<li data-marpit-fragment="2">Two</li>
<li data-marpit-fragment="3">Three</li>
</ul>
</section>
```

?> Fragmented list does not change DOM structure and appearances. It relys on a behavior of the integrated app whether actually treats the rendered list as fragments.
13 changes: 11 additions & 2 deletions docs/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,14 @@ bar

## Extended features

- [Directives](/directives)
- [Image syntax](/image-syntax)
### [Directives](/directives)

Marpit Markdown has extended syntax called **"Directives"** to support writing awesome slides. It can control your slide-deck theme, page number, header, footer, style, and so on.

### [Image syntax](/image-syntax)

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

### [Fragmented list](/fragmented-list)

Since v0.9.0, Marpit will parse lists with specific markers as the **fragmented list** for appearing contents one by one.