https://github.com/stoplightio/markdown
Useful functions when working with Markdown.
https://github.com/stoplightio/markdown
Last synced: about 1 year ago
JSON representation
Useful functions when working with Markdown.
- Host: GitHub
- URL: https://github.com/stoplightio/markdown
- Owner: stoplightio
- License: apache-2.0
- Created: 2018-12-03T09:21:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T13:50:51.000Z (over 1 year ago)
- Last Synced: 2025-04-05T22:43:22.061Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 2.2 MB
- Stars: 6
- Watchers: 15
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @stoplight/markdown
[](https://codeclimate.com/github/stoplightio/markdown/maintainability)
[](https://codeclimate.com/github/stoplightio/markdown/test_coverage)
Useful functions when working with Markdown. Leverages the Unified / Remark ecosystem under the hood.
- Explore the interfaces: [TSDoc](https://stoplightio.github.io/markdown)
- View the changelog: [Releases](https://github.com/stoplightio/markdown/releases)
### Installation
Supported in modern browsers and node.
```bash
# latest stable
yarn add @stoplight/markdown
```
### Usage
#### Example `parse`
```ts
import { parse } from '@stoplight/markdown';
const result = parse('**markdown**');
console.log(result); // => the MDAST compliant tree
```
### Contributing
1. Clone repo.
2. Create / checkout `feature/{name}`, `chore/{name}`, or `fix/{name}` branch.
3. Install deps: `yarn`.
4. Make your changes.
5. Run tests: `yarn test.prod`.
6. Stage relevant files to git.
7. Commit: `yarn commit`. _NOTE: Commits that don't follow the
[conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional) format will be
rejected. `yarn commit` creates this format for you, or you can put it together manually and then do a regular
`git commit`._
8. Push: `git push`.
9. Open PR targeting the `develop` branch.