From e36011d282f26723209c0613c9d4c4ba35fbed31 Mon Sep 17 00:00:00 2001 From: Yuki Hattori Date: Tue, 22 Jan 2019 04:25:47 +0900 Subject: [PATCH 1/2] Update README.md and introduction on docs - Update badges to add icon - Improved sentence explained about Marp Next and core - Add sub-projects section to link to SVG polyfill --- README.md | 13 +++++++++---- docs/introduction.md | 3 ++- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c8b36570..ec5065a4 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ Marpit: Markdown slide deck framework

- CircleCI - Codecov - npm + CircleCI + Codecov + npm LICENSE

@@ -17,8 +17,9 @@ Marpit is designed to _output minimum assets for the slide deck_. You can use the bare assets as a logicless slide deck, but mainly we expect to integrate output with other tools and applications. -This framework is actually created for use as [a core][marp-core] of the next version of [Marp](https://github.com/yhatt/marp/). +In fact, this framework is created for using as the base of [a core converter][marp-core] in [the next version of Marp][marp]. +[marp]: https://github.com/marp-team/marp/ [marp-core]: https://github.com/marp-team/marp-core/ ## Features @@ -57,6 +58,10 @@ yarn build Are you interested in contributing? Please see [CONTRIBUTING.md](.github/CONTRIBUTING.md). +## Sub-projects + +- **[@marp-team/marpit-svg-polyfill](https://github.com/marp-team/marpit-svg-polyfill)** - A polyfill of the inline SVG slide in Safari based browsers. + ## Author Managed by [@marp-team](https://github.com/marp-team). diff --git a/docs/introduction.md b/docs/introduction.md index ab7031fe..6d93d031 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,3 +1,4 @@ +[marp]: https://github.com/marp-team/marp/ [marp-core]: https://github.com/marp-team/marp-core

@@ -13,7 +14,7 @@ Marpit is designed to _output minimum assets for the slide deck_. You can use the bare assets as a logicless slide deck, but mainly we expect to integrate output with other tools and applications. -This framework is actually created for use as [a core][marp-core] of the next version of [Marp](https://github.com/yhatt/marp/). +In fact, this framework is created for using as the base of [a core converter][marp-core] in [the next version of Marp][marp]. ## Features From e8e9f1c04c906178380d8432449c1ce9332d0655 Mon Sep 17 00:00:00 2001 From: Yuki Hattori Date: Wed, 23 Jan 2019 02:03:16 +0900 Subject: [PATCH 2/2] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ac683e5c..f8221cb2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## [Unreleased] +### Changed + +- Small update for README and docs ([#122](https://github.com/marp-team/marpit/pull/122)) + ## v0.6.0 - 2019-01-19 ### Added