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

Create a site for shisui #217

Open
GrapeBaBa opened this issue Nov 1, 2024 · 2 comments
Open

Create a site for shisui #217

GrapeBaBa opened this issue Nov 1, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@GrapeBaBa
Copy link
Member

Create a GH page using mkdocs for shisui like fluffy

@GrapeBaBa GrapeBaBa added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Nov 1, 2024
@r4f4ss
Copy link

r4f4ss commented Nov 14, 2024

@GrapeBaBa trin builded its trin book using mdbook, which uses rust.

Fluffy uses Material for MkDocs, wich uses python.

As of Shisui is a golang project, I'd like to suggest that we consider to use the static site generator writen in go hugo. According to sources 1 and 2 it is as easy as Material for MkDocs and have good reviews.

Eitherway, I am not oposed to use Material for MkDocs just as Fluffy.

Edit

Also, geth have a outdated gh-pages documentation using jekyll, their documentation is currently in their website, so I think there is no geth style in this specific case, we must find ours.

@GrapeBaBa
Copy link
Member Author

@GrapeBaBa trin builded its trin book using mdbook, which uses rust.

Fluffy uses Material for MkDocs, wich uses python.

As of Shisui is a golang project, I'd like to suggest that we consider to use the static site generator writen in go hugo. According to sources 1 and 2 it is as easy as Material for MkDocs and have good reviews.

Eitherway, I am not oposed to use Material for MkDocs just as Fluffy.

Edit

Also, geth have a outdated gh-pages documentation using jekyll, their documentation is currently in their website, so I think there is no geth style in this specific case, we must find ours.

For my previous exp, mkdocs is good enough if we no need customize style, otherwise we used https://stackshare.io/docusaurus such as the site of optimism-java

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants