Skip to content

Commit

Permalink
docs: add blog post about new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bionus committed Aug 17, 2023
1 parent 9bb7f2e commit 4ab008d
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
Binary file added docs/assets/img/blog/new-homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/blog/old-homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/blog/posts/2023-08-18-new-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
date: 2023-08-18 00:54:00 +0200
authors: [Bionus]
---


# New docs

Hello everyone!

 

The documentation website for Grabber now has a new look!

I felt that the old look led to many people simply not reading the docs, and the navigation wasn't all that intuitive.

<!-- more -->

The documentation website, as well as the homepage and blog, are now based on the excellent [MkDocs Material](https://squidfunk.github.io/mkdocs-material/). It allows for not only easier-to-read docs, but also easier-to-write documentation! Hopefully this will lead to less confused users.

Some new features include:

- A better theme
- A search input
- Table of contents navigation on the right
- A dark/light mode switch

For those that did not have the chance to see the previous look, here is a before and after of the homepage:

![Before](../../assets/img/blog/old-homepage.png){ width="49%" }
![After](../../assets/img/blog/new-homepage.png){ width="49%" }

Thanks again to everyone using and supporting Grabber everyday!

&nbsp;

Best,
Bionus

0 comments on commit 4ab008d

Please sign in to comment.