Olaf, Ad. 1) I personally don't want wiki for documentation. That is only the proposition to use wiki on your repository in order to simplify things and investigate whether we can transform it to the GitHub pages. Do you know the way how to do this ?
Ad. 2) I think Carlos need help with run even simple Hello World using Jekyll on our royale-docs. If someone can help with that it would be great. Thanks, Piotr 2018-01-16 10:46 GMT+01:00 Olaf Krueger <[email protected]>: > Hi, > > >How do we create navigation that shows up on each page of the > >documentation > > To be clear: > There are two common ways of creating a documentation by using GitHub: > > 1) Using the GitHub Wiki > 2) Using GitHub pages > > 1) > Here the navigation is provided by using the Wikis' sidebar. > You have to put some Marddown into the _Sidebar in order to build the > navigation structure. > All articles has to be written in MarkDown. > I noticed that our Royale-docs repo does not provide a Wiki. > If we would like to use it we have to enable it at first. Does anybody know > how to enable the Wiki? > The main drawback of the Wiki is, that (as far as I know) we can't use pull > request. There are revisons for particular articles, but it feels that a > lot > of things are done behind the scene. > Moreover I guess we can't customize the look and feel. > > 2) > This is they way Carlos would like to go. > With GitHub pages you can use e.g. Jekyll, which is a static site > generator. > This produces a more sophisticated look and feel. > We have to grab a Jekyll template and customize it and make it all work. > When all is in place we could start with creating content. > The entire code/content could be managed in the same way as any other code > repository. > > I guess we would like to go with GitHub pages? > > Hope this helps, > Olaf > > > > > > > -- > Sent from: http://apache-royale-development.20373.n8.nabble.com/ > -- Piotr Zarzycki Patreon: *https://www.patreon.com/piotrzarzycki <https://www.patreon.com/piotrzarzycki>*
