CEH-in-bullet-points icon indicating copy to clipboard operation
CEH-in-bullet-points copied to clipboard

Reader-friendly modifications - help needed ?

Open shafr opened this issue 2 years ago • 5 comments

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:

  • index on the left (unordered due to alphabetical sorting)
  • chapters on the right
  • page changes on the bottom

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 avatar Sep 06 '21 04:09 shafr

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

shafr avatar Sep 09 '21 10:09 shafr

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 avatar Sep 09 '21 10:09 shafr

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

shafr avatar Sep 09 '21 11:09 shafr

Implemented dark color theme. Thanks Tasmota!

shafr avatar Sep 10 '21 04:09 shafr

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.

undergroundwires avatar Dec 30 '21 20:12 undergroundwires