зеркало из https://github.com/github/markup.git
more README clarity
This commit is contained in:
Родитель
de903b8c5a
Коммит
3405de8b8f
|
@ -1,9 +1,9 @@
|
|||
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:
|
||||
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. This library selects an _underlying library_ to convert the raw markup to HTML. See the list of [supported markup formats](#markups) below.
|
||||
1. `github-markup` selects an _underlying library_ to convert the raw markup to HTML. See the list of [supported markup formats](#markups) below.
|
||||
1. 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.
|
||||
1. Syntax highlighting is performed on code blocks. See [github/linguist](https://github.com/github/linguist#syntax-highlighting) for more information about syntax highlighting.
|
||||
1. The HTML is passed through other filters in the [html-pipeline](https://github.com/jch/html-pipeline) that add special sauce, such as [emoji](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/emoji_filter.rb), [task lists](https://github.com/github/task_list/blob/master/lib/task_list/filter.rb), [named anchors](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb), [CDN caching for images](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/camo_filter.rb), and [autolinking](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/autolink_filter.rb).
|
||||
|
|
Загрузка…
Ссылка в новой задаче