1
0
mirror of synced 2025-12-21 10:57:10 -05:00
Files
docs/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md
David Yang 03db50e01b Use the same processor name that it is in _config.yml (#8679)
* Use the same name that it is in _config.yml

* Update setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md

Co-authored-by: hubwriter <hubwriter@github.com>
2021-08-03 16:08:22 +00:00

2.2 KiB

title, intro, redirect_from, product, versions, topics, shortTitle
title intro redirect_from product versions topics shortTitle
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 {% data variables.product.prodname_pages %} site.
/articles/migrating-your-pages-site-from-maruku/
/articles/updating-your-markdown-processor-to-kramdown/
/articles/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll
/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll
{% data reusables.gated-features.pages %}
fpt ghes ghae
* * *
Pages
Set Markdown processor

People with write permissions for a repository can set the Markdown processor for a {% data variables.product.prodname_pages %} site.

{% data variables.product.prodname_pages %} supports two Markdown processors: kramdown and {% data variables.product.prodname_dotcom %}'s own Markdown processor, which is used to render {% data variables.product.prodname_dotcom %} Flavored Markdown (GFM) throughout {% data variables.product.product_name %}. For more information, see "About writing and formatting on {% data variables.product.prodname_dotcom %}."

You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with either processor, but only our GFM processor will always match the results you see on {% data variables.product.product_name %}.

{% data reusables.pages.navigate-site-repo %} 2. In your repository, browse to the _config.yml file. {% data reusables.repositories.edit-file %} 4. Find the line that starts with markdown: and change the value to kramdown or GFM. Markdown setting in config.yml {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %}

Further reading