DjangoGirls / tutorial

This is a tutorial we are using for Django Girls workshops
http://tutorial.djangogirls.org/
Other
1.52k stars 1.86k forks source link

Add shell annotations on code blocks in English docs. #1801

Open techdragon opened 11 months ago

techdragon commented 11 months ago

Changes in this pull request:

techdragon commented 11 months ago

I used shell as the docs appear to be using HighlightJS, and the documentation says that shelland console are both aliases for the same thing. https://highlightjs.readthedocs.io/en/latest/supported-languages.html

Having never used honkit I'm not completely sure if there's any preprocessing that would get in the way and complicate this situation though... but I based the PR on the HighlightJS docs since the honkit code for syntax highlighting (https://github.com/honkit/honkit/tree/d058ddfcd0837af110c9f2d49f612bc0b75390b4/packages/%40honkit/honkit-plugin-highlight) looks like its just a wrapper around HighlightJS.

Edit: Would you still like the shell swapped for console even though they should be functional equivalent aliases @ekohl ?

shweta-borganve commented 8 months ago

Hello, could you enable me for write access to the repo? I would like to commit changes by resolving conflicts. Thank you

das-g commented 8 months ago

Hello, could you enable me for write access to the repo? I would like to commit changes by resolving conflicts. Thank you

Which repo, @shweta-borganve? For contributions to https://github.com/DjangoGirls/tutorial please "fork" it on GitHub, make your changes in your "fork" or push them there, then file a pull request. For https://github.com/techdragon/tutorial, @techdragon would have to decide whether to give you push access, but also there you could work with pull requests.

Is this related to this PR here (#1801 «Add shell annotations on code blocks in English docs.»)? If needed I can give some pointers on how to get its commit into your own fork of https://github.com/DjangoGirls/tutorial, so that you can build upon it.

shweta-borganve commented 8 months ago

@das-g Thank you very much for details, I will proceed accordingly and contact if needed.