GitHub - ClydeDz/markdown-to-api: Generate JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator. Render a Markdown document using the GitHub markdown API GitHub Instantly share code, notes, and snippets.
Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.
- Render a Markdown document using the GitHub markdown API GitHub Instantly share code, notes, and snippets.
- Online markdown editor with realtime html preview. Convert Raw.md Raw.html.html.
- REST API overview → Learn about resources, libraries, previews and troubleshooting for GitHub's REST API. Reference → View reference documentation to learn about the resources available in the GitHub REST API. Guides → Learn about getting started with the REST API, authentication, and how to use the REST API for a variety of tasks.
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
You can use Markdown most places around GitHub:
- Comments in Issues and Pull Requests
- Files with the
For more information, see “Writing on GitHub” in the GitHub Help.
Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.
GitHub Flavored Markdown
Markdown Cheatsheet Github
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.
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:
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!
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
|First Header||Second Header|
|Content from cell 1||Content from cell 2|
|Content in the first column||Content in the second column|
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.
@ 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.
Any word wrapped with two tildes (like
~~this~~) will appear crossed out.
GitHub supports emoji!
To see a list of every image we support, check out the Emoji Cheat Sheet.
Last updated Jan 15, 2014
GitHub is an awesome place to host your open source project code. MooTools, Prototype, and jQuery all use GitHub. As you probably know, the MooTools Forge requires your plugins be hosted on GitHub. The only problem with hosting all my MooTools plugins is that I lose traffic when I want people to see my code. Problem solved: use PHP, the GitHub API, and PHP Markdown to display files of my choice on my website.
Our goals with this code will be to:
- Connect to GitHub via the API to retrieve repository information.
- Retrieve the content of two files from the repository: a source file and the README.md Markdown file.
- Cache the information for a given period of time to reduce the load on GitHub.
- Use PHP Markdown to output a formatted README.md file.
I know that seems like a lot of work but you'll be amazed at how easy the process is.
Github Markdown Html
You may download PHP Markdown at Michel Fortin's website. It's simple and full of features.
Github Readme Cheat Sheet
The first step is to build a PHP function that will connect to GitHub using cURL:
Next we need to define a few settings:
The next step is to create another PHP function that grabs the repository information (JSON-encoded, because I love JSON) -- either fresh from GitHub (by first grabbing the most recent commit hash, then grabbing the contents of the two files) or our local cached information:
Once we've acquired the appropriate information, we output the information to screen:
That's all! Now I get the benefit of hosting my code on GitHub but displaying it on my own website. I've created a special WordPress template page to do so and recommend you do too!
Visit my Projects page and click on the 'Docs' link for any project. All of the information that comes up on individual project pages comes from GitHub. No more manual page creation!