Skip to content
This repository has been archived by the owner on Sep 27, 2019. It is now read-only.

Re-skin #230

Open
lsaether opened this issue Jul 24, 2019 · 3 comments
Open

Re-skin #230

lsaether opened this issue Jul 24, 2019 · 3 comments

Comments

@lsaether
Copy link
Contributor

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?

@lsaether lsaether changed the title Reskin Re-skin Jul 24, 2019
@laboon
Copy link
Collaborator

laboon commented Jul 26, 2019

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
Copy link
Contributor Author

lsaether commented Aug 7, 2019

@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.

@laboon
Copy link
Collaborator

laboon commented Aug 16, 2019

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants