search

optimism-java / shisui

Ethereum Portal Network Client written in Go
https://www.ethportal.net/clients/shisui
GNU Lesser General Public License v3.0
6 stars 6 forks source link

Create a site for shisui #217

Open GrapeBaBa opened 2 weeks ago

GrapeBaBa commented 2 weeks ago

Create a GH page using mkdocs for shisui like fluffy

r4f4ss commented 5 days ago

@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 commented 4 days ago

@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