Article version: GitHub.com
Setting a Markdown processor for your GitHub Pages site using Jekyll
You can choose a Markdown processor to determine how Markdown is rendered on your GitHub Pages site.
GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."
People with write permissions for a repository can set the Markdown processor for a GitHub Pages site.
GitHub Pages supports two Markdown processors: kramdown and GitHub's own extended CommonMark processer, which is used to render GitHub Flavored Markdown throughout GitHub. For more information, see "About writing and formatting on GitHub."
You can use GitHub Flavored Markdown with either processor, but only our CommonMark processor will always match the results you see on GitHub.
On GitHub, navigate to your site's repository.
In your repository, browse to the _config.yml file.
In the upper right corner of the file view, click to open the file editor.
Find the line that starts with
markdown:and change the value to
At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."
Below the commit message fields, click the email address drop-down menu and choose a Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then
<username>@users.noreply.github.comis the default commit author email address. For more information, see "Setting your commit email address."
Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is
master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."
Click Propose new file.