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

Reader-friendly modifications - help needed ? #13

Open
shafr opened this issue Sep 6, 2021 · 5 comments
Open

Reader-friendly modifications - help needed ? #13

shafr opened this issue Sep 6, 2021 · 5 comments

Comments

@shafr
Copy link

shafr commented Sep 6, 2021

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
Copy link
Author

shafr commented Sep 9, 2021

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

@shafr
Copy link
Author

shafr commented Sep 9, 2021

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
Copy link
Author

shafr commented Sep 9, 2021

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

@shafr
Copy link
Author

shafr commented Sep 10, 2021

Implemented dark color theme. Thanks Tasmota!

@undergroundwires undergroundwires pinned this issue Dec 30, 2021
@undergroundwires
Copy link
Owner

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.

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