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

Markdown guide refers to Highlightjs but Rouge is used #183

Closed
GjjvdBurg opened this issue Apr 24, 2019 · 1 comment · Fixed by #188
Closed

Markdown guide refers to Highlightjs but Rouge is used #183

GjjvdBurg opened this issue Apr 24, 2019 · 1 comment · Fixed by #188
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@GjjvdBurg
Copy link

Thanks for building Jupyter-Book! I stumbled on a very minor issue in the documentation that caused some confusion and that you might want to fix.

The Markdown cheatsheet at ./jupyter_book/book_template/content/features/limits.md refers users to the highlightjs list of language names, but as far as I can tell from _config.yml the syntax highlighting is actually done by rouge. The list of languages between the two is not the same and neither is the result. This caused some confusion because my Makefile syntax wasn't highlighted correctly and this turned out to be a bug in rouge.

Pinging @alexmorley because it explains this problem as well.

@choldgraf
Copy link
Collaborator

ah - I believe that information isn't actually correct, it should in-fact be using Rouge...@alexmorley just added that page to test how Jupyter-Book handles really long pages. I think we should change that information to make sure it's correct!

@choldgraf choldgraf added the enhancement New feature or request label Apr 25, 2019
@emdupre emdupre added the good first issue Good for newcomers label Apr 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants