Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shurcooL/github_flavored_markdown

GitHub Flavored Markdown renderer with fenced code block highlighting, clickable header anchor links.
https://github.com/shurcooL/github_flavored_markdown

Last synced: 3 months ago
JSON representation

GitHub Flavored Markdown renderer with fenced code block highlighting, clickable header anchor links.

Host: GitHub
URL: https://github.com/shurcooL/github_flavored_markdown
Owner: shurcooL
License: mit
Created: 2015-05-16T04:09:07.000Z (over 9 years ago)
Default Branch: main
Last Pushed: 2023-11-26T23:16:25.000Z (12 months ago)
Last Synced: 2024-07-14T13:35:47.740Z (4 months ago)
Language: Go
Homepage:
Size: 72.3 KB
Stars: 158
Watchers: 5
Forks: 43
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-go-extra - github_flavored_markdown - 05-16T04:09:07Z|2021-02-28T21:35:44Z| (Bot Building / Markup Languages)

README

        github_flavored_markdown

========================

[![Go Reference](https://pkg.go.dev/badge/github.com/shurcooL/github_flavored_markdown.svg)](https://pkg.go.dev/github.com/shurcooL/github_flavored_markdown)

[![Build Status](https://travis-ci.org/shurcooL/github_flavored_markdown.svg?branch=master)](https://travis-ci.org/shurcooL/github_flavored_markdown)

Package github_flavored_markdown provides a GitHub Flavored Markdown renderer

with fenced code block highlighting, clickable heading anchor links.

The functionality should be equivalent to the GitHub Markdown API endpoint specified at

https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode, except

the rendering is performed locally.

See examples for how to generate a complete HTML page, including CSS styles.

Installation

------------

```bash

go get github.com/shurcooL/github_flavored_markdown

```

Directories

-----------

| Path                                                                                 | Synopsis                                                                     |

|--------------------------------------------------------------------------------------|------------------------------------------------------------------------------|

| [gfmstyle](https://pkg.go.dev/github.com/shurcooL/github_flavored_markdown/gfmstyle) | Package gfmstyle contains CSS styles for rendering GitHub Flavored Markdown. |

License

-------

-	[MIT License](LICENSE)