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. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML). This page is maintained by and for the markdown community to document various tools and resources available to document authors and developers, as well as implementors of the various markdown implementations.

• Github Pages Markdown
• Github Markdown Code
• Github Markdown Website Examples
• Github Markdown To Html
• Github Markdown Style
• Github Markdown Website Builder
• Image Markdown Github

Introduction

Markdown-it demo. Html xhtmlOut breaks linkify typographer highlight CommonMark strict clear permalink. Fork me on GitHub. GitHub Flavored Markdown, often shortened as GFM, is the dialect of Markdown that is currently supported for user content on GitHub.com and GitHub Enterprise. This formal specification, based on the CommonMark Spec, defines the syntax and semantics of this dialect. You get one site per GitHub account and organization, and unlimited project sites. Let‘s get started. User or organization site; Project site; Create a repository. Head over to GitHub and create a new public repository named username.github.io, where username is your username (or organization name) on GitHub.

This little guide demonstrate how to turn any Github repository with a bunch of Markdown files into a simple website using Github Pages and Jekyll.

• You don’t need to use the command line or anything other than your browser.
• It doesn’t require any knowledge in Jekyll.
• It’s completely compatible with any bunch of markdown files you already have in any existing repository without any modification to those files. That includes the basic README.md almost all repositories contain.
• The markdown files will remain just as readable and usable in Github than in your website.

In fact this guide uses the same configuration and can be read both in Github and in Github Pages, at your preference:

Step by step instructions

Determine the repository where you want to activate Github Pages

You can of course create a new repository if you want.

Create the _config.yml file

That file should be created on the root of your repository. Here is some content to copy-paste in it:

It’s basically just a few tuning of Github Pages’ default configuration to have a better handling of Markdown files.

Github Pages Markdown

Activate Github Pages in your repository configuration

On the Github page of your project go into Settings > Options > Github Pages:

Github Markdown Code

In the Source option, select master branch then Save:

You must also choose a theme:

That’s it! Now you can juste use the link provided by Github to access you website:

Usage guide

Github Markdown Website Examples

• Any markdown file in your repository will display in your Github Pages website. You just have to use the same path to access it and replace the .md extension by .html.
• To make links between your Markdown files just use a relative path to the other Markdown file. The configuration you copy pasted in your _config.yml provides a plugin to convert those URLs. So your Markdown files will have correct links both in Github and Github Pages.
• The index page of your website can be a index.md file or a README.md file. If both exists the index.md file has priority.
• You should be able to use any Github Flavored Markdown.

Github Markdown To Html

Known differences between Github and Github Pages

• No automatic links with Github Pages. The Github Markdown renderer can automatically detect a simple copy-pasted link and make it a clickable link. Github Pages doesn’t propose a feature to reproduce that behavior, so you’ll have to braces your links with the []() syntax.

Recipes

Since the purpose of this guide is to demonstrate how to publish multiple Markdown files as a website but I don’t have much more to say I will propose you some delicious recipes instead:

Other Github Pages related projects

Github Markdown Style

I’m a fan of Github Pages for the possibilities it offers to anyone to publish a website for free. I have multiple projects that could be of interest if that’s your case too:

Github Markdown Website Builder

Contributing

Image Markdown Github

See the Contribution Guide.

License

See the License File.