HackerReposA FIELD GUIDE TO OPEN SOURCE
ProSponsor the shelf♧ 0
← Back to top all-time
github
markup
Ruby2011–2026
github / markup

markup

Determines which markup library to use to render a content file (e.g. README) on GitHub

Libraries & SDKs
Explore on GitHubRead Hacker News discussions
27Distinct people
31Mentions
1Explicit recommenders
6.1KGitHub stars
REPOSITORY AT A GLANCE

What to know before exploring

What it is

Determines which markup library to use to render a content file (e.g. README) on GitHub

GitHub

Where it is used

No documented product use was verified in the last source check.

What people are saying

Why do this with markdown? Github supports other [1] markup languages, many of which were designed to be edited programmatically. The format produced by such tools are not…

syrrim used a recommendation phrase. One indexed comment matches. This is a phrase match, not a verdict.

No classified warning is attached to this page. Read the discussions before treating silence as approval.

Also in these discussions

No other repository is repeatedly linked in the same discussions.

This week on Hacker News

Nov 7–Nov 14 UTC · Direct repository links and separately labeled related project stories. Indexed through 11/14/2026, 6:01:08 PM UTC.

No direct repository links were found in the indexed HN discussions over the past seven days. Older discussions are available below.

Mentions over time

HN mentions by year31 dated mentions

Observed mentions: 2011-01-18 12:58:27 UTC to 2026-06-02 03:49:13 UTC.

012342011-01-01 00:00:00 UTC to 2012-01-01 00:00:00 UTC (exclusive): 2 mentions; 0 submissions, 2 comments20112012-01-01 00:00:00 UTC to 2013-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2013-01-01 00:00:00 UTC to 2014-01-01 00:00:00 UTC (exclusive): 4 mentions; 2 submissions, 2 comments2014-01-01 00:00:00 UTC to 2015-01-01 00:00:00 UTC (exclusive): 4 mentions; 0 submissions, 4 comments2015-01-01 00:00:00 UTC to 2016-01-01 00:00:00 UTC (exclusive): 3 mentions; 0 submissions, 3 comments2016-01-01 00:00:00 UTC to 2017-01-01 00:00:00 UTC (exclusive): 2 mentions; 1 submissions, 1 comments2017-01-01 00:00:00 UTC to 2018-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2018-01-01 00:00:00 UTC to 2019-01-01 00:00:00 UTC (exclusive): 4 mentions; 0 submissions, 4 comments20182019-01-01 00:00:00 UTC to 2020-01-01 00:00:00 UTC (exclusive): 4 mentions; 0 submissions, 4 comments2020-01-01 00:00:00 UTC to 2021-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2021-01-01 00:00:00 UTC to 2022-01-01 00:00:00 UTC (exclusive): 2 mentions; 0 submissions, 2 comments2022-01-01 00:00:00 UTC to 2023-01-01 00:00:00 UTC (exclusive): 3 mentions; 0 submissions, 3 comments2023-01-01 00:00:00 UTC to 2024-01-01 00:00:00 UTC (exclusive): 2 mentions; 0 submissions, 2 comments2024-01-01 00:00:00 UTC to 2025-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2025-01-01 00:00:00 UTC to 2026-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2026-01-01 00:00:00 UTC to 2027-01-01 00:00:00 UTC (exclusive): 1 mentions; 0 submissions, 1 comments. Incomplete calendar period.2026*

* An incomplete calendar period is marked with an outlined bar. Its count is not directly comparable with a full period.

Counts come from the repository’s dated source evidence. Index cutoff: 2026-11-02 08:16:59 UTC.

View mention counts and date ranges
UTC ranges include their start and exclude their end. Select a period to filter the source evidence.
PeriodStart (UTC)End (exclusive, UTC)MentionsSubmissionsComments
20112011-01-01 00:00:00 UTC2012-01-01 00:00:00 UTC202
20122012-01-01 00:00:00 UTC2013-01-01 00:00:00 UTC000
20132013-01-01 00:00:00 UTC2014-01-01 00:00:00 UTC422
20142014-01-01 00:00:00 UTC2015-01-01 00:00:00 UTC404
20152015-01-01 00:00:00 UTC2016-01-01 00:00:00 UTC303
20162016-01-01 00:00:00 UTC2017-01-01 00:00:00 UTC211
20172017-01-01 00:00:00 UTC2018-01-01 00:00:00 UTC000
20182018-01-01 00:00:00 UTC2019-01-01 00:00:00 UTC404
20192019-01-01 00:00:00 UTC2020-01-01 00:00:00 UTC404
20202020-01-01 00:00:00 UTC2021-01-01 00:00:00 UTC000
20212021-01-01 00:00:00 UTC2022-01-01 00:00:00 UTC202
20222022-01-01 00:00:00 UTC2023-01-01 00:00:00 UTC303
20232023-01-01 00:00:00 UTC2024-01-01 00:00:00 UTC202
20242024-01-01 00:00:00 UTC2025-01-01 00:00:00 UTC000
20252025-01-01 00:00:00 UTC2026-01-01 00:00:00 UTC000
2026 (partial)2026-01-01 00:00:00 UTC2027-01-01 00:00:00 UTC101

From the project README

An excerpt from the repository, fetched Nov 13, 2026.

Read the project’s introduction
GitHub Markup This library is the first step of a journey that every markup file in a repository goes on before it is rendered on GitHub.com: github-markup selects an underlying library to convert the raw markup to HTML. See the list of supported markup formats below. The HTML is sanitized, aggressively removing things that could harm you and your kin—such as script tags, inline-styles, and class or id attributes. Syntax highlighting is performed on code blocks. See github/linguist for more information about syntax highlighting. The HTML is passed through other filters that add special sauce, such as emoji, task lists, named anchors, CDN caching for images, and autolinking. The resulting HTML is rendered on GitHub.com. Please note that only the first step is covered by this gem — the rest happens on GitHub.com. In particular, markup itself does no sanitization of the resulting HTML, as it expects that to be covered by whatever pipeline is consuming the HTML. Please see our contributing guidelines before reporting an issue. Markups The following markups are supported. The dependencies listed are required if you wish to run the library. You can also run script/bootstrap to fetch them all. .markdown, .mdown, .mkdn, .md -- gem install commonmarker (https://github.com/gjtorikian/commonmarker) .textile -- gem install RedCloth (https://github.com/jgarber/redcloth) .rdoc -- gem install rdoc .org -- gem install org-ruby (https://github.com/wallyqs/org-ruby) .creole -- gem install creole (https://github.com/larsch/creole) .mediawiki, .wiki -- gem install wikicloth (https://github.com/nricciar/wikicloth) .rst -- pip install docutils .asciidoc, .adoc, .asc -- gem install asciidoctor (http://asciidoctor.org) .pod -- Pod::Simple::XHTML comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN. Installation gem install github-markup or bundle install from this directory. Usage Markdown rendering supports CommonMarker 0.x and 2.x. Keep the installed version to retain that parser's option behavior. Extensions follow the installed parser; 2.x-only extensions remain unavailable with 0.x. Basic form: require 'github/markup' GitHub::Markup.render('README.markdown', "* One\n* Two") More realistic form: require 'github/markup' GitHub::Markup.render(file, File.read(file)) And a convenience form: require 'github/markup' GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "* One\n* Two") Local Development python3 -m venv .venv source .venv/bin/activate cd script ./bootstrap Set COMMONMARKER_VERSION to override the development bundle's default ~> 2.8.2 requirement. See Testing for parser version commands. Contributing See Contributing.
Read the full README on GitHub

What Hacker News says

4 sources
indralukmana·Dec 27, 2013Submission

Ask HN: MS Word alternatives for writing academic reports

Right now i am searching for an alternative for writing academic reports (master thesis). in the past i have written such reports (bachelor final projects) with MS Word and it is NOT an enjoyable experience. Whereas latex is widely used for academic reports, i don't really want to learn something so complex only for academic reports, i want to learn something that also can be used for general usage (documentation, blog writing, etc). Here i found out about restructuredtext and markdown as a markup language for documentation. After some reading i concluded that restructuredtext is more in tune with what i am trying to accomplish e.g: it can be converted into latex if i want to incorporate bibliography from latex What are your experiences on using markup language for writing general or academic documents(using figures, tables, bibliography,
Read the rest
etc)? do you have suggestions regarding this topic? PS: I mainly using linux amd Here are some applications for writing markup language that i found: https://notex.ch/ (rst, markup, latex) -- it seems to be made with GWT http://rst.ninjs.org/ (rst) https://github.com/github/markup (many) http://sourceforge.net/projects/retext/ edit: i agree with the expression "when you have a hammer, you see every problem as a nail" as stated by commenters. but right now i am not proficient enough with a tool to switch or compare with another one. some commenter suggest that i really invest in learning latex. i was starting to learn latex from wikipedia wikibook when i got intimidated by it and went to searching for alternatives. based on the commenters some ways/applications to ease this learning are: 1. lyx 2. www.writelatex.com 3. using latex templates 4. scrivener any other suggestions?
22 points · Open discussion
fakeer·Apr 26, 2013
Why was reST not supported and contributed to by the community, BTW? I saw a comparison here[1] and good that GitHub supports[2] other markups too. I don't think there's much of a need to move to Markdown other than just for the sake of using something else. I remember reading Jeef's post The Future of Markdown[3] few months ago and then what ensued was really frustrating [4]. [1]http://www.unexpected-vortices.com/doc-notes/markdown-and-re... [2]https://github.com/github/markup [3]http://www.codinghorror.com/blog/2012/10/the-future-of-markd... [4]https://twitter.com/gruber/status/262287246953164800
In Why Markdown Is Not My Favourite Language

MAKE YOURSELF AT HOME

A few shortcuts

/
Search the collection
?
Open this guide
Esc
Close dialogs and navigation

Your saved repositories and interests stay in this browser.