github-wiki.github.io
Unofficial Wiki about GitHub usage
- github-wiki.github.io
- Automatically Generated Table of Contents
- Markups
- Inline HTML
- GitHub pages
- Modifying an old branch and propagating changes to more recent ones
- See also
Automatically Generated Table of Contents
GitHub Pages (Markdown)
GitHub Pages use a different Markdown as repository viewer!
Automatic TOC in github-flavoured-markdown
GitHub Pages (which is basically a wrapper for Jekyll) appears to use kramdown, which implements all of Maruku, and therefore has support for an automatically generated table of contents via atoc attribute:
* auto-gen TOC:
{:toc}
Inside GitHub (AsciiDoc)
- Issue 215, comment 336328746
- AsciiDoc
- AsciiDoc cheatsheet
Markups
- https://github.com/github/markup
GitHub Flavored Markdown (GFM)
- https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown
Inline HTML
- Which inline html styles does GitHub markdown accept?
- https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/sanitization_filter.rb
GitHub pages
Kramdown
Lint
- See Setting up your GitHub Pages site locally with Jekyll
- markdownlint / markdownlint
- DavidAnson / markdownlint
- https://www.npmjs.com/package/markdown-lint
Jekyll
Setting up your GitHub Pages site locally with Jekyll
Configuring Jekyll _config.yml
- Configuring Jekyll
- Configuring Jekyll plugins
- Updating your Markdown processor to kramdown
- _config.yml
Feeds (RSS, Atom)
Modifying an old branch and propagating changes to more recent ones
- Merging a pull request on GitHub
- About Git rebase
- About pull request merges
- Rebase and merge your pull request commits