adding a static site generator to reuse header and footer

[dhmlau]

From @virkt25

We should look into adding a static site generator so we can separate the site header / footer for reuse -- I'm thinking a Node based one (VuePress looks promising)

Acceptance Criteria

• Pick a static site generator
  • @virkt25 suggested VuePress or Hexo
• create the site header and footer as template using the static site generator

[dhmlau]

@virkt25 , you have more details on it. could you please see if the acceptance criteria make sense, otherwise edit accordingly? thanks.

[virkt25]

That looks good to me, I personally think we should try VuePress out of the two choices. As a follow up task to this, once we have the docs page implemented -- we should update the doc markdown files to the appropriate front-matter + change code highlighting (if needed) to make use of features such as line highlighting, etc.

[ui-guys]

Is this open to suggestions? If yes, why not look at Gatsby

[virkt25]

@ui-guys Since the task hasn't been started, it's most certainly open to suggestion. My preference for VuePress is mostly because it's designed for technical documentation whereas Gatsby looks like a jack of all trades.

Can you share some benefits of Gatsby / share a repo where it's used for technical documentation so I can see how it's done / how easy / complicated it is.

Also, would you be interested in contributing?

[ui-guys]

the best known docu site built with gatsby is reactjs.org, but there are more showcases on their website:
https://next.gatsbyjs.org/showcase/?filters%5B0%5D=Documentation