Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/z0al/gfmc
JavaScript pure implementation of GitHub Flavored Markdown (GFM) specification :octocat:
https://github.com/z0al/gfmc
compiler gfm markdown nodejs rollup
Last synced: about 2 months ago
JSON representation
JavaScript pure implementation of GitHub Flavored Markdown (GFM) specification :octocat:
- Host: GitHub
- URL: https://github.com/z0al/gfmc
- Owner: z0al
- License: mit
- Created: 2017-10-16T08:39:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-25T11:28:56.000Z (about 7 years ago)
- Last Synced: 2024-11-30T16:52:21.779Z (about 2 months ago)
- Topics: compiler, gfm, markdown, nodejs, rollup
- Language: TypeScript
- Homepage:
- Size: 228 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GFM Compiler
[](https://travis-ci.org/ahmed-taj/gfmc)
[](https://www.npmjs.com/package/gfmc)
[](#contributors)
JavaScript pure implementation of [GitHub Flavored Markdown](https://github.github.com/gfm) (GFM) specification.
## Why?
- ✅ %100 Specification compliance
- 🚫 No dependencies
- 🚀 Works in Node.js, and Browser
## Installation
**NOTE:** I haven't published the npm package yet. It will automatically get published by Travis when all [spec](./test/spec.ts) tests are passing
```sh
$ npm add --save gfmc
```
## Usage
```javascript
import gfmc from('gfmc')
const markdown = '# This is title '
console.log(gfmc(markdown))
// =>
//
This is title
```
## Options
```typescript
gfmc(src: string, options: Object)
```
| Option | Description |
| :---------------- | :------------------------------------------------------------------------------------ |
| renderer {Object} | A custom Renderer to be used by the Parser (default: [HTMLRenderer](./src/render.ts)) |
## Progress
The project is still in active development and currently doesn't support:
- Fenced code blocks
- HTML blocks
- Link reference definitions
- Tables
- Block quotes
- Lists
- Task lists
- Backslash escapes
- Code spans
- Emphasis and strong emphasis
- Strikethrough
- Links
- Images
- Autolinks
- Raw HTML
- Hard line breaks
- Soft line breaks
- Textual content
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
| [
Ahmed T. Ali](https://github.com/ahmed-taj)
[📝](#blog-ahmed-taj "Blogposts") [💻](https://github.com/ahmed-taj/gfmc/commits?author=ahmed-taj "Code") [📖](https://github.com/ahmed-taj/gfmc/commits?author=ahmed-taj "Documentation") [⚠️](https://github.com/ahmed-taj/gfmc/commits?author=ahmed-taj "Tests") | [
Ashe Connor](https://kivikakk.ee)
[💬](#question-kivikakk "Answering Questions") |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ahmed-taj/gfmc/releases).
## Like it?
Give it a star(⭐️) 👆
## License
MIT © [Ahmed T. Ali](https://github.com/ahmed-taj)