Documentation site example

[rahul286]

I am trying to create a documentatio site like - https://segment.io/docs/

Can anybody please point me to valid example/sample sites which has above site like structure? i.e. pages, sub-pages, navigation, etc.

[jokesterfr]

Just found out a Markdown based wiki : mdwiki. It is very handy to make a static documentation website. As md compilation is done by the browser, you can host it on github pages.

[rahul286]

@jokesterfr thanks for the link. :-)

It is very nice but looks in early stage.

mdwiki sites are not yet google indexable and also they do not have clean permalink support. (https://github.com/Dynalon/mdwiki/issues/131)

Apart from this YAML front-matter is important for my needs - https://github.com/Dynalon/mdwiki/issues/107

I will explore mdwiki more as it seems a nice fit. :-)

[ianstormtaylor]

We're going to be publishing a blog post on how we built the Segment docs with Metalsmith soon hopefully, but closing for now since this ticket is old and not really solveable by core :)