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

Add docs styling and tweaks #77

Merged
merged 23 commits into from
Mar 15, 2023
Merged

Add docs styling and tweaks #77

merged 23 commits into from
Mar 15, 2023

Conversation

calvellido
Copy link
Member

This PR adapts the docs templates to the proposed design.

Summary

  • Decorated titles.
  • Adapted docs and category cards according to the proposal.
  • A refactor of the category pages. Now an index.md file is needed, but it can be mostly copypasted from oterh files juts modifying its title. The sidebar items are still autogenerated, like before.
  • Code snippets using a proper colour theme and font family (JetBrains Mono).
  • Adapted admonitions.
  • Added Arrow styled icons.
  • Arrow style themed sidebar
  • Themed Mermaid diagrams.
  • Some other small details and titbits, like the proper alignment of navbar, titles, toc, etc.

Preview

image
image
image
image
image

@serras
Copy link
Member

serras commented Mar 14, 2023

Everything looks great!

@calvellido One small detail: would it be possible to make the six rectangles in Overview a bit shorter? I'm a bit worried people may not realize there's more content afterwards. Otherwise we could add some text that makes it clear that there's more information there.

@calvellido
Copy link
Member Author

Everything looks great!

@calvellido One small detail: would it be possible to make the six rectangles in Overview a bit shorter? I'm a bit worried people may not realize there's more content afterwards. Otherwise we could add some text that makes it clear that there's more information there.

I made in 16b401d a small adaptation for them to have less padding. They now look like this:

image

@calvellido calvellido merged commit 6284eb7 into main Mar 15, 2023
@calvellido calvellido deleted the calvellido-docs-tweaks branch March 15, 2023 11:19
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

Successfully merging this pull request may close these issues.

None yet

2 participants