diff --git a/README.md b/README.md index b870170..e6e7bea 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@

- Marpit + Marpit + Marpit

Marpit: Markdown slide deck framework @@ -11,6 +12,12 @@ LICENSE

+
+ +### [🗒 Documentation](https://marpit.marp.app/) | [⚙ API](https://marpit-api.marp.app/) + +
+ --- **Marpit** /mɑːrpɪt/ is the skinny framework for creating slide deck from Markdown. It can transform Markdown and CSS theme(s) to slide deck composed of static HTML and CSS and create a web page convertible into slide PDF by printing. @@ -45,21 +52,20 @@ See [the documentation of Marpit](https://marpit.marp.app/?id=getting-started) t - **[Documentation](https://marpit.marp.app/)** - [API (JSDoc)](https://marpit-api.marp.app/) -## Development +## Contributing + +Are you interested in contributing? See [CONTRIBUTING.md](.github/CONTRIBUTING.md) and [the common contributing guideline for Marp team](https://github.com/marp-team/.github/blob/master/CONTRIBUTING.md). + +### Development ```bash git clone https://github.com/marp-team/marpit - cd marpit yarn install yarn build ``` -## Contributing - -Are you interested in contributing? Please see [CONTRIBUTING.md](.github/CONTRIBUTING.md) and [the common contributing guideline for Marp team](https://github.com/marp-team/.github/blob/master/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. diff --git a/docs/marpit-dark.png b/docs/marpit-dark.png new file mode 100644 index 0000000..cb8bbd0 Binary files /dev/null and b/docs/marpit-dark.png differ diff --git a/docs/marpit.png b/docs/marpit.png index 133f9be..a45b181 100644 Binary files a/docs/marpit.png and b/docs/marpit.png differ