w3f / polkadot-wiki-old

The Polkadot wiki.
https://wiki.polkadot.network
55 stars 40 forks source link

Re-skin #230

Open lsaether opened 5 years ago

lsaether commented 5 years ago

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?

laboon commented 5 years ago

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?

lsaether commented 5 years ago

@laboon What are your thoughts on migrating to Docusaurus? Substrate Dev Hub uses it and it seems to work pretty well for them.

Pros:

Cons:

laboon commented 5 years ago

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:

  1. Has translation services built-in (but see cons)
  2. Will keep us in line w/ Parity
  3. Uses node which most people will know how to use already

CONs of Docusaurus:

  1. It is a bit more complex than we probably need
  2. Translation / i18n requires third part dependency (crowdin)

PROS of SkyDocs:

  1. Very simple and straightforward
  2. Uses Markdown
  3. Basic i18n built-in

CONS of SkyDocs:

  1. Not extremely popular
  2. Written in Java
  3. Translation will require generating new file trees and keeping them updated