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 a community page #20

Merged
merged 4 commits into from
Dec 21, 2021
Merged

Add a community page #20

merged 4 commits into from
Dec 21, 2021

Conversation

tisonkun
Copy link
Contributor

@tisonkun tisonkun commented Dec 21, 2021

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:

The issue here is aimed at UI/framework however. We're not in a hurry and I'm open to do some investigations before ordering contents. Maybe finally docu is the best choice with trade-offs.

Generally, I kept these goals in mind:

  • We'll finally use a full-featured frontend primary framework like docusaurus or next.js, which can natively customize arbitrary logics with frontend technology. However, it requires experienced frontend experts to handle all subtle cases.
  • Thus, the framework should be easy-to-use for our current contributors, who are almost system developers.
  • Although, the framework should be flexible enough so that customization can be done.

Docusaurus

Live demos:

Reasons not to use:

  • Strange config settings comparing to YAML files used by mkdocs/jekyll
  • The framework is heavy and somehow clumsy (Can't reference links to docs from Blog facebook/docusaurus#3250).
  • JSX is too complex to use. MDX is an edge tech that isn't proven to be useful and I don't want to learn it.
  • SPA (single page application) doesn't attract me.

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:

Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Copy link
Contributor

@huachaohuang huachaohuang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, it looks nice locally. I don't know these things very much, so I think I just merge it then :)

@huachaohuang huachaohuang merged commit 0ab1b16 into engula:main Dec 21, 2021
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.

Find a flexible website framework to publish Engula site Page is lack of meta for rendering on Twitter
2 participants