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

Code blocks in the "Tips and command snippets" section don't render properly #798

Closed
evertrol opened this issue Jul 26, 2018 · 1 comment

Comments

@evertrol
Copy link
Contributor

The code blocks in the "Tips and command snippets" section render as indented, but otherwise normal, text; not as code. See https://zero-to-jupyterhub.readthedocs.io/en/latest/tips.html
It looks like this is because of missing double colons ::, or a .. code-block:: bash directive as used elsewhere.

(The potentially most problematic issue is that -- for long options renders as an n-dash, instead of two dashes, making it not possible to copy-paste the occasional line.)

Funnily enough, when viewed on GitHub directly, it renders better: https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/doc/source/tips.rst . I guess GitHub's ReST parser is quite lenient.

I have not found any other pages that have this problem (but I haven't gone through all of them yet).

Since this is a relatively straightforward change, I'd be happy to put in a PR for this.

@consideRatio
Copy link
Member

@evertrol ❤️ ❤️ ❤️ :D

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

No branches or pull requests

2 participants