All Projects → github → Markup

github / Markup

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

Programming Languages

ruby
36898 projects - #4 most used programming language
python
139335 projects - #7 most used programming language
Dockerfile
14818 projects
shell
77523 projects
perl
6916 projects
Raku
181 projects

Labels

Projects that are alternatives of or similar to Markup

repo-standards
A starter kit for setting up a new repo, including a checklist of what to include in your README and templates for other recommended files
Stars: ✭ 26 (-99.51%)
Mutual labels:  readme
Waka Readme
Wakatime Weekly Metrics on your Profile Readme.
Stars: ✭ 386 (-92.74%)
Mutual labels:  readme
The Documentation Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (-19.04%)
Mutual labels:  readme
Format Readme
Формат файла README
Stars: ✭ 270 (-94.92%)
Mutual labels:  readme
Github Profile Readme Generator
GitHub profile readme generator allows you to create nice and simple GitHub profile readme files that will be included in your profile previews.
Stars: ✭ 374 (-92.97%)
Mutual labels:  readme
Github Profile Readme Generator
🚀 Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.
Stars: ✭ 7,812 (+46.87%)
Mutual labels:  readme
actions-readme-feed
Display RSS feed in your GitHub Profile README
Stars: ✭ 26 (-99.51%)
Mutual labels:  readme
Storybook Readme
React Storybook addon to render README files in github style
Stars: ✭ 511 (-90.39%)
Mutual labels:  readme
Github Markdown Toc.go
Easy TOC creation for GitHub README.md (in go)
Stars: ✭ 387 (-92.72%)
Mutual labels:  readme
Markdownview Android
MarkdownView is an Android webview with the capability of loading Markdown text or file and display it as HTML, it extends Android webview.
Stars: ✭ 432 (-91.88%)
Mutual labels:  readme
Readme Template
📜 Modelos readme para qualquer pessoa copiar e usar em seu GitHub.
Stars: ✭ 287 (-94.6%)
Mutual labels:  readme
Github Activity Readme
Updates README with the recent GitHub activity of a user
Stars: ✭ 354 (-93.34%)
Mutual labels:  readme
Awesome Readme Templates
A collection of awesome readme templates to display on your github profile.
Stars: ✭ 423 (-92.05%)
Mutual labels:  readme
Readmetemplate
Done with your project but having a hard time writing a ReadMe? Check Out This Repo I created. If you like it then use it
Stars: ✭ 255 (-95.21%)
Mutual labels:  readme
Creative Profile Readme
A Collection of GitHub Profiles with awesome readme
Stars: ✭ 449 (-91.56%)
Mutual labels:  readme
teteusAraujo
Meu readme do meu perfil com informações sobre mim.
Stars: ✭ 123 (-97.69%)
Mutual labels:  readme
Standard Readme
A standard style for README files
Stars: ✭ 4,412 (-17.05%)
Mutual labels:  readme
Markdown Magic
💫 Automatically format markdown files, sync external docs/src code & make better docs
Stars: ✭ 551 (-89.64%)
Mutual labels:  readme
Badgen
Fast handcraft svg badge generator.
Stars: ✭ 464 (-91.28%)
Mutual labels:  readme
Make A Readme
📄 Because nobody can read your mind (yet)
Stars: ✭ 426 (-91.99%)
Mutual labels:  readme

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:

  1. github-markup selects an underlying library to convert the raw markup to HTML. See the list of supported markup formats below.
  2. 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.
  3. Syntax highlighting is performed on code blocks. See github/linguist for more information about syntax highlighting.
  4. The HTML is passed through other filters that add special sauce, such as emoji, task lists, named anchors, CDN caching for images, and autolinking.
  5. 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.

Installation

gem install github-markup

or

bundle install

from this directory.

Usage

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")

Contributing

See Contributing.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].