Shadowrocket-ADBlock-Rules icon indicating copy to clipboard operation
Shadowrocket-ADBlock-Rules copied to clipboard

Create a simple website

Open matteo-grella opened this issue 5 years ago • 8 comments

@evanmcclure what do you think about a simple landing page?

matteo-grella avatar Jun 19 '20 16:06 matteo-grella

I think it's a great idea. What are your thoughts about the design of the landing page?

evanmcclure avatar Jun 20 '20 16:06 evanmcclure

I like the simple layout of the website for the gRPC open-source project (https://grpc.io).

evanmcclure avatar Jun 26 '20 21:06 evanmcclure

It appears we can use https://pages.github.com

evanmcclure avatar Jul 02 '20 00:07 evanmcclure

we can just create a repository and start the website and documentation in a separate repository. we can use Hugo to edit and build the page. then host it here on Github. as mentioned on the GitHub page it just has to be the same name as the repo owner.

something like spago.github.com will be great

JusticeN avatar Oct 28 '20 20:10 JusticeN

or even better like the hugo documentation see https://github.com/gohugoio/hugo#the-hugo-documentation

own repo for the doc and add it as git subtree in the main spago repo

JusticeN avatar Oct 28 '20 20:10 JusticeN

I would suggest Antora and ASCII doc for this. No need to start using subtrees and it can quote code from the source tree etc. ASCII doc (.adoc) files are supported natively by GitHub and Antora can publish to github pages.

jimidle avatar Jun 29 '21 02:06 jimidle

Hey @jimidle,

Thanks for this!

I'm wondering if you have time to support us on this topic, using Antora and ASCII doc as you suggested.

Just in case, in this presentation there are a few high level code examples we may use to getting started.

Thanks again,

Matteo

matteo-grella avatar Jun 29 '21 03:06 matteo-grella

Hi Matteo,

If I can use this code within my project, then I am happy to offer help with the project, including Setting up Antora etc to generate Github pages.

Basically, if I can load my own trained models (rather than download from HuggingFace, though that's where the models are that I base my training on), and the performance is good, then I will contribute. Definitely with documentation and also code.

I presume that you will want contributions via a fork of the repo and pull requests?

jimidle avatar Jun 29 '21 03:06 jimidle

Closing for inactivity.

matteo-grella avatar Nov 01 '23 11:11 matteo-grella