search

undergroundwires / CEH-in-bullet-points

💻 Certified ethical hacker summary in bullet points
https://cloudarchitecture.io/hacking
Creative Commons Attribution 4.0 International
995 stars 287 forks source link

Reader-friendly modifications - help needed ? #13

Open shafr opened 3 years ago

shafr commented 3 years ago

Thanks for your effort! However it's not very reader-friendly - have you thought about using any docs system for your project ? (with reading mode, etc ?). Would you like your repo to be converted into reader-friendly site? (I thought about mkdocs with material). This would adding indexes to files & commiting some code from mkdocs. Here is example screenshot of what I tried locally.

Note the features:

Please let me know if I should start working on it. Then you can publish it on github pages & everyone can look at it in more reader-friendly mode.

image

shafr commented 3 years ago

Implemented in #14 . Please pin this issue in case someone would have other requests / issues with PDF or mkdocs site.

shafr commented 3 years ago

Also known issue is PDF links - i'm not sure what is the best way to fix cross-reference for now. Maybe someone can update links, so all of them would have some kind of # prefix that is recognized in pdf ?

shafr commented 3 years ago

Dark theme is also a good thing to do https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/

shafr commented 3 years ago

Implemented dark color theme. Thanks Tasmota!

undergroundwires commented 2 years ago

Thank you @shafr . This is awesome. I was very slow at reacting to the change, but now I have time. Keeping this issue pinned as requested until we merge the PR.