Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Update markdown processor to use GFM #5810

Merged

Conversation

charlottetan
Copy link
Contributor

@charlottetan charlottetan commented Oct 3, 2021

What does this PR do?

Improve repo: Update the markdown processor to use GFM instead of the default (kramdown). GFM is the processor Github uses. Resolves #5559.

Docs for more information:

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll

Examples here:

https://charlottetan.github.io/free-programming-books/CONTRIBUTING-fa_IR.html

https://charlottetan.github.io/free-programming-books/HOWTO-fa_IR.html

For resources

Description

Why is this valuable (or not)?

How do we know it's really free?

For book lists, is it a book? For course lists, is it a course? etc.

Checklist:

  • Read our contributing guidelines
  • Search for duplicates.
  • Include author(s) and platform where appropriate.
  • Put lists in alphabetical order, correct spacing.
  • Add needed indications (PDF, access notes, under construction)

Follow-up

  • Check the status of GitHub Actions and resolve any reported warnings!

@davorpa
Copy link
Member

davorpa commented Oct 3, 2021

❗ Update pr title with scope fix(docs): ....

ℹ️ remove non scoped tasks

@davorpa
Copy link
Member

davorpa commented Oct 3, 2021

More docs about GMF & Kramdown: https://jekyllrb.com/docs/configuration/markdown/#commonmark

🆗 I have not seen any other listing break.

_config.yml Show resolved Hide resolved
@davorpa davorpa added the waiting for changes PR has been reviewed and changes/suggestions requested label Oct 3, 2021
@charlottetan charlottetan changed the title Update markdown processor to use GFM fix(docs): Update markdown processor to use GFM Oct 3, 2021
Copy link
Member

@davorpa davorpa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready to merge 🎆 🎉

Thanks for your valuable researches

@davorpa davorpa removed the waiting for changes PR has been reviewed and changes/suggestions requested label Oct 3, 2021
@eshellman
Copy link
Collaborator

Awesome teamwork

@eshellman eshellman merged commit 8c5ece6 into EbookFoundation:master Oct 4, 2021
@charlottetan charlottetan deleted the charlottetan-markdown-gfm branch January 24, 2022 05:56
@charlottetan charlottetan restored the charlottetan-markdown-gfm branch January 24, 2022 05:56
@charlottetan charlottetan deleted the charlottetan-markdown-gfm branch January 24, 2022 05:56
@davorpa davorpa added the 🐛 BUG Confirmed bugs, normally at GitHub Pages label Feb 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 BUG Confirmed bugs, normally at GitHub Pages
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GHP bad rendering on CONTRIBUTE & HOWTO (fa_IR locale)
3 participants