polkadot-wiki-old
polkadot-wiki-old copied to clipboard
Re-skin
Found this cool looking wiki skin using hexo called wikitten. Hexo is a pretty nice static site generator based on Markdown files.
@laboon @ansonla3 Thoughts on a re-skin?
I think a re-skin is a good idea. Our wiki looks pretty generic as-is.
I'm not a big fan of this one, though - it kind of reminds me of Windows 3.1 with the rectangles around everything.
I wonder if we could find a skin that has the same sort of theme as https://polkadot.network/.
Or do you know how difficult it is to make a theme ourselves? Or modify an existing one?
@laboon What are your thoughts on migrating to Docusaurus? Substrate Dev Hub uses it and it seems to work pretty well for them.
Pros:
- Simple static files generation so we can host on GH pages instead of depending on readthedocs.
- Nice localization integration using CrowdIn.
- Support from big dogs like FaceBook... Looks like even Libra uses it for their documentation.
- Uses React for setting up a landing page and constructing supplementary pages to just the documentation.
Cons:
- More than just a static site generator. Might end up being more than we need.
So I took a look at Docusaurus and a couple of other programs. I think it's down to Docusaurus and SkyDocs.
PROs of Docusaurus:
- Has translation services built-in (but see cons)
- Will keep us in line w/ Parity
- Uses node which most people will know how to use already
CONs of Docusaurus:
- It is a bit more complex than we probably need
- Translation / i18n requires third part dependency (crowdin)
PROS of SkyDocs:
- Very simple and straightforward
- Uses Markdown
- Basic i18n built-in
CONS of SkyDocs:
- Not extremely popular
- Written in Java
- Translation will require generating new file trees and keeping them updated