Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can checkout the code locally and explore by
mkdocs server
.Screenshot:
Investigation
TL;DR
I've tried both docusaurus, hugo, and jekyll in the weekend. After notice that mkdocs with materials can be flexibly customized. I chose to customize the theme and add the community page as well as several improvement discussed before.
Goal
In #19 (comment) I wrote:
Generally, I kept these goals in mind:
Docusaurus
Live demos:
Reasons not to use:
Hugo
Live demos:
Actually, I made a branch to adopt hugo with docsy theme and I think it's almost good to use. However, hugo's DSL is a learning burden and I don't think it's well-designed.
Jekyll
Live demos:
Jekyll can be customized flexibly and I like its orthogonal designs of template syntax. However, I don't find a good theme to get start with, and write everything from scratch is simply unacceptable.
Mkdocs
Live demos:
Mkdocs has a similar template syntax with Jekyll that I can understand. And I notice how to customize materials theme. So I just use it.
Reference
Other community page examples: