- Light and a dark theme, Auto save, Live Preview, Convert html to markdown, Save to Dropbox.source implementation of Markdown for C# and Javascript.
- Markdown to html, Html to markdown.
Markdown Implementations
Either direct or other lists
Code to convert markdown to html is available in all major programing languages. Download it, then, just run.
- stackoverflow Question 11 lists some and references
Specific implementations
In Python universe, some packages. There are more.
- Markdown with its features
In Perl, there is a package:
Wikipedia has a list that is reproduced here, so that we can add/remove columns and Markdown processors.
| Name | Language | Type | Description | Official site |
|---|---|---|---|---|
| mmd2pdf | Autoit | - | MultiMarkdown to PDF converter | google code |
| md2html.awk | Awk | Converter | Markdown to Html | bitbucket |
| apache-mod-sundown | C | Apache HTTPd module | Using Sundown C library | github |
| Discount | C | Library and HTML converter | - | site |
| libpandoc | C | Multiconverter | - | github |
| peg-multimarkdown | C | - | Using parsing expressing grammar (PEG) | github, github fork |
| peg-markdown | C | - | Using parsing expressing grammar (PEG) | github |
| PEG Markdown Highlight | C | Syntax highlighter | Using parsing expressing grammar (PEG) | site |
| Sundown | C | - | - | github |
| libupskirt | C | Parser | Fork of libsoldout | github |
| libsoldout | C | Parser | Simple parser only | site |
| Doxygen | C++ | Sourcecode documentation generator | Doxygen supports Markdown with extra features | site |
| Cpp-Markdown | C++ | Generator | Markdown to HTML | sourceforge |
| RStudio | C++ | IDE for R (programming language) | C++ wrapper for sundown | site |
| Qarkdown | C++ | Editor (Qt) | Simple crossplatform Markdown editor using Qt | site |
| MarkdownSharp | C# | - | - | google code |
| MoonShine | C# | - | - | github |
| Sundown.net | C# | - | - | github |
| markdown-clj | Clojure | Converter | Generates HTML from Markdown, compiles to both Clojure and ClojureScript | github |
| Blackfriday | Go | - | - | github |
| Goskirt | Go | - | - | github |
| MaTeS | Go | Converter to HTML5 | Creates web pages or presentation slides. Supports citation, tables, math and charts. | site |
| Upskirt.go | Go | - | - | github |
| Pandoc | Haskell | Converter (Multiformat) | - | site |
| Sundown HS | Haskell | - | - | github |
| MarkdownJ | Java | - | - | google code |
| pegdown | Java | - | - | github |
| MarkdownPapers | Java | - | Implementation based on a JavaCC parser | site |
| Txtmark | Java | - | - | github |
| Markdown4j | Java | - | Extensible markdown java implementation | google code |
| Dillinger | JavaScript | Editor | 'WYSIWYM' editor | site, github |
| uedit | JavaScript | Editor | 'WYSIWYM' editor | github |
| node-discount | JavaScript | - | node.js binding for Discount | github |
| markdown-js | JavaScript | - | Parser for JavaScript/node.js | github |
| marked | JavaScript | - | A fast markdown parser | github |
| PageDown | JavaScript | Webeditor and viewer | Used by Stack Exchange sites | google code and github |
| PageDown-Bootstrap | JavaScript | Webeditor and viewer | Fork of PageDown which uses the Twitter Bootstrap template framework | github |
| Showdown | JavaScript | Webeditor and viewer | - | site/github |
| markdown.pioul.fr | JavaScript | Webeditor and viewer | Minimalist Online Markdown Editor | site |
| TextDown | JavaScript | Editor plugin for Chrome | - | chrome store/github |
| texts.js | JavaScript | Node.js module | PEG-based grammar, intermediate format in JSON | github |
| markdown.lua | Lua | - | - | luaforge |
| Lunamark | Lua | Converter | HTML and LaTeX converter | github |
| lua-discount | Lua | Binding | - | site |
| node-multimarkdown | Node.js | Parser | Native MultiMarkdown extension for Node.js | github |
| RobotSkirt | Node.js | - | - | github |
| node-markdown | Node.js | - | Parse Markdown syntax with node.js | github |
| gfm | Node.js | - | The port of Showdown used on github.com | github |
| Markdown | Perl 6 | Parser | Markdown parser in Perl 6 | github |
| Markdown.pl | Perl | Converter to (X)HTML | Official author perl markdown implementation | site |
| MultiMarkdown | Perl | Converter | Markdowns originals MultiMarkdown superset | site, github |
| text-markdown | Perl | Converter to (X)HTML | - | github |
| markdown-oo-php | PHP | Converter to (X)HTML | Object-oriented implementation of Markdown | github |
| markdown-handler | PHP | Converter to (X)HTML | github | |
| PHP Markdown | PHP | Converter to HTML | - | site |
| PHP Markdown Extra | PHP | Converter to HTML | Markdown with extra options | site |
| PHP Markdown Extended | PHP | Converter to various formats (HTML, MAN, extensible) | Markdown extended syntax | github |
| PHP Markdown Viewer | PHP | Viewer | Wrapper for PHP Markdown | site |
| secondcrack | PHP | Blog | A static-file Markdown blogging engine | github, site |
| qlmarkdown | Objective C | - | A Mac OS X Quicklook extension that uses Discount. | github |
| Python-Markdown | Python | - | A implementation with various extensions such as tables and ignoring internal bold/italic markings. | site |
| Misaka | Python | Binding | Python binding for Sundown | site |
| BlueCloth | Ruby | - | - | site |
| BlueFeather | Ruby | - | - | site |
| ffi-sundown | Ruby | - | - | github |
| gimli | Ruby | Markdown to PDF | - | gimli |
| kramdown | Ruby | Library | - | rubyforge |
| md2man | Ruby | Converter | Markdown to manpage | github |
| markdownr.com | Ruby | Webviewer and Editor | A nifty markdown notepad | site/github |
| Maruku | Ruby | Interpreter | - | github |
| RDiscount | Ruby | Binding | Ruby binding for Discount | github |
| Redcarpet | Ruby | Binding | Ruby binding for Sundown | github |
| Knockoff | Scala | - | - | site |
| Actuarius | Scala | - | - | site |
| Lowdown | Chicken Scheme | Parser library (egg) | Can emit SXML | chicken wiki, Bitbucket |
| markdown.bash | Bash | Converter | Markdown to Html | Github |
Alternative lightweight markup formats
Because GitHub's README styling is actually really nice
Background
If you have a little side project, often you might want a simple landing page. The GitHub README rendering is really beautifully done: clean, simple and modern. The official GitHub markdown to HTML API generates the HTML code, but not the stylesheets necessary to make it look nice.
Using your GitHub README as the main landing point works great for open source projects, where your visitors are developers and are familiar with GitHub, as well as you have all the text right where the code, the Issues and PRs are. But for some projects this isn't ideal. I built this project within a few hours for myself to get WalkWithFriends off the ground fast, without investing in building an actual website, or using a bloated website builder.
Some issues you run into when using GitHub as your main landing page
- Maybe your project isn't actually an open source project, so you can't just host a
READMEon GitHub - If you want to link to just the
README, you could append#readmeto your browser URL (making the URL less pretty), or the visitor has to know they have to scroll down - The mobile page of GitHub is still pretty bad, and it only renders the first few lines, as soon as you have a logo and badges on your page, it doesn't render at all, unless the visitor hits
View all ofREADME.md- Non-tech visitors don't know what's a
README.md - The button is small, and people don't know what is
- GitHub renders the GitHub Pulse below, something that doens't make sense for non-tech visitors
- The URL changes from something nice like
github.com/krausefx/fastlanetogithub.com/krausefx/fastlane/blob/master/README.md, meaning you can either link directly to this page to have a nice content, or you link to the root page and have the downside of the extra buttons - Nat announced, that they working on improving the mobile experience, which is great news for everybody :)
- Non-tech visitors don't know what's a
- You can't use your own domain
- If you use your own domain, you have to use GitHub Pages (which is excellent btw), but then you have to have HTML files ready, which is exactly what this project solves.
Solution
A simple script that converts a markdown (.md) file to a single HTML file, that includes all the HTML and CSS code inline, so you can host it anywhere.
There is no need to use this script if you already convert your markdown file to HTML, you can directly use the stylesheet of this repo.
How it works
This project doesn't actually use the GitHub stylesheet, it's far too complex, and has legal implications.
Instead this project does 2 things:
- Convert the Markdown to HTML using showdown, the most popular JS markdown parser. This could be replaced by the official GitHub markdown to HTML API
- Inject the GitHub-like CSS code at the bottom of the page
Resulting you get an HTML file that contains everything needed, so you can host the page on GitHub pages, AWS S3, Google Cloud Storage or anywhere else.
- Check out the original markdown file of this
README - Check out the raw generated HTML code generated based on this markdown file on
- Check out the GitHub rendered README
- Check out the README rendered by this project
Usage
This will read the README.md from your current working directory and output the resulting HTML as README.html to the same directory.
Open tasks
Render Markdown To Html C#
Check out the open issues, in particular code blocks currently don't support syntax highlighting, however that's something that's rather easy to add. For a minimalistic stylesheet we could take the styles from krausefx.com css.
Playground to test
- Bullet list item 1
- Bullet list item 2
- Bullet list item 2.1
- Bullet list item 2.2
- Numbered list item 1
- Numbered list item 2
Inline code comments are 100
Quoted texts are more gray and look differently
Bold text is bold and inline links work as well.
Markdown To Html C# Nuget
Header 2
Header 3
Header 4
Header 5
Normal text content again, lorem ipsum
| Text 1 | Text 2 | Text 3 |
|---|---|---|
| Text 1 | Text 2 | Text 3 |
| Text 1 | Text 2 | Text 3 |
C# Parse Markdown To Html
🔰 Raw HTML code for custom style 🔰