Skip to content

Commit

Permalink
Fix image links, and add links for docs separately
Browse files Browse the repository at this point in the history
  • Loading branch information
yhatt committed Nov 13, 2022
1 parent 9ff13e8 commit 4bebd90
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<p align="center">
<a href="https://marpit.marp.app">
<img src="docs/marpit.png#gh-light-mode-only" alt="Marpit" width="500" />
<img src="docs/marpit-dark.png#gh-dark-mode-only" alt="Marpit" width="500" />
</a>
<img src="docs/marpit.png#gh-light-mode-only" alt="Marpit" width="500" />
<img src="docs/marpit-dark.png#gh-dark-mode-only" alt="Marpit" width="500" />
</p>
<p align="center">
<strong>Marpit</strong>: Markdown slide deck framework
Expand All @@ -14,6 +12,12 @@
<a href="./LICENSE"><img src="https://img.shields.io/github/license/marp-team/marpit.svg?style=flat-square" alt="LICENSE" /></a>
</p>

<div align="center">

### [🗒 Documentation](https://marpit.marp.app/) | [⚙ API](https://marpit-api.marp.app/)

</div>

---

**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.
Expand Down Expand Up @@ -48,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.
Expand Down

0 comments on commit 4bebd90

Please sign in to comment.