1. Github Markdown Examples
2. Github Markdown Anchor Example
3. Github Flavored Markdown Example
4. Github Markdown Example File

Loads and collates markdown topic files using a YAML encoded book that organizes thetopics into a book. This is sort of like a highly watered down version of DITA.

Important - There are no unit tests yet.

Installation

Github Markdown Examples

While GitHub won't interpret the MathJax formulas, you can automatically generate a new Markdown document with the formulae replaced by images. I suggest you look at the GitHub app TeXify: GitHub App that looks in your pushes for files with extension.tex.md and renders it's TeX expressions as SVG images. How it works (from the source repository). Medium Editor Markdown. Created with JavaScript and from Romania. Browse the code on GitHub. You know, the Medium Editor library is awesome. But there is a missing feature that some people would like to have. It's called Markdown.

Usage - build command

Usage - clean command

Example book.yaml

Contribution Agreement

This project is licensed under the MIT license (see LICENSE). To be in the bestposition to enforce these licenses the copyright status of this project needs tobe as simple as possible. To achieve this the following terms and conditionsmust be met:

• All contributed content (including but not limited to source code, text,image, videos, bug reports, suggestions, ideas, etc.) must be thecontributors own work.

• The contributor disclaims all copyright and accepts that their contributedcontent will be released to the public domain.

• The act of submitting a contribution indicates that the contributor agreeswith this agreement. This includes (but is not limited to) pull requests, issues,tickets, e-mails, newsgroups, blogs, forums, etc.

Current Tags

• 1.0.0 ... latest (4 years ago)

2 Versions

• 1.0.0 ... 4 years ago
• 0.1.0 ... 4 years ago

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.

What you will learn:

• How the Markdown format makes styled collaborative editing easy
• How Markdown differs from traditional formatting approaches
• How to use Markdown to format text
• How to leverage GitHub’s automatic Markdown rendering
• How to apply GitHub’s unique Markdown extensions

What is Markdown?

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

You can use Markdown most places around GitHub:

• Comments in Issues and Pull Requests
• Files with the .md or .markdown extension

For more information, see “Writing on GitHub” in the GitHub Help.

Examples

Syntax guide

Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.

Headers

Emphasis

Lists

Unordered

Ordered

Images

Links

Blockquotes

Inline code

GitHub Flavored Markdown

GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.

Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests. Task Lists are also available in Gist comments and in Gist Markdown files.

Syntax highlighting

Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:

You can also simply indent your code by four spaces:

Here’s an example of Python code without syntax highlighting:

Task Lists

If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!

Tables

Github Markdown Anchor Example

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

Would become:

Github Flavored Markdown Example

SHA references

Any reference to a commit’s SHA-1 hash will be automatically converted into a link to that commit on GitHub.

Issue references within a repository

Any number that refers to an Issue or Pull Request will be automatically converted into a link.

Username @mentions

Typing an @ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.

Automatic linking for URLs

Any URL (like http://www.github.com/) will be automatically converted into a clickable link.

Strikethrough

Any word wrapped with two tildes (like ~~this~~) will appear crossed out.

Emoji

GitHub supports emoji!

To see a list of every image we support, check out the Emoji Cheat Sheet.

Github Markdown Example File

Last updated Jan 15, 2014