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

Consider updating looks of Pinax docs #150

Open
KatherineMichel opened this issue Jun 23, 2019 · 2 comments
Open

Consider updating looks of Pinax docs #150

KatherineMichel opened this issue Jun 23, 2019 · 2 comments

Comments

@KatherineMichel
Copy link
Member

I think we should consider changing the Pinax docs theme, perhaps as part of our upcoming release. The docs have had the same look for a while. An example of a possible theme is Sphinx Alabaster. I think it is now a default Sphinx theme. Imo, it's a nice clean, modern look. Let me know what you think!

@KatherineMichel
Copy link
Member Author

KatherineMichel commented Jun 27, 2019

Update: mkdocs has some additional themes, including its own version of Alabaster that apparently works with markdown. Cinder, Bootstrap and GitBook are also nice imo. Looks-wise, I think I'm partial to Alabaster and GitBook personally, although I haven't checked out the differences in features. In general, I prefer the ones that have a clean, elegant look and less bright colors. The Python docs for example, were transitioned from darker colors to less bright and I think they look more modern. https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes

@KatherineMichel
Copy link
Member Author

Screenshots of the two options I like atm:
Alabaster
screencapture-katherinemichel-github-io-pinax-2019-06-27-17_32_49
GitBook
screencapture-katherinemichel-github-io-pinax-2019-06-27-19_17_33

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

1 participant