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

Basic markdown syntax issue #17

Closed
Ravieroy opened this issue Jul 4, 2022 · 2 comments · Fixed by #18
Closed

Basic markdown syntax issue #17

Ravieroy opened this issue Jul 4, 2022 · 2 comments · Fixed by #18

Comments

@Ravieroy
Copy link

Ravieroy commented Jul 4, 2022

Thank you for issue #15. Having made the website I can see that basic syntax like highlighting using equals(=) symbol, underline using caret(^) symbol is not working as expected. I have made another page using this template as a test and there it seems to work. Attached are the images of the issue and the website is hosted here if needed

😞
highlight_issue

😊
expectation

Thanks a lot.

@Ravieroy
Copy link
Author

Ravieroy commented Jul 4, 2022

Okay, I could make it work as it was an easy fix and may be it will be added soon, but for others if they want it to do it themselves, here it is. It was a matter of simple edit in mkdocs.yml file. In the section for markdown_extensions we need to add certain keywords. I got this from here

markdown_extensions:

  • pymdownx.critic
  • pymdownx.caret
  • pymdownx.keys
  • pymdownx.mark
  • pymdownx.tilde

P.S: Similarly admonition plugin can also be activated. Refer this for admonition plugin.

While this was easy, it would have been nice if these functionality comes default in the template as these are useful. Thanks for this template though.

@jobindjohn
Copy link
Owner

Fixed it now. Thanks @Ravieroy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants