build local user guide

[Anonymous]

Hi,

Is it possible to build a local copy of user guide (https://www.rosettacommons.org/docs/latest/Home) ?

Thank you.

[Anonymous]

The contents of this wiki are in the documentation repository that’s available alongside the source code repository on the downloads page.  I don’t know how to actually build it – it’s a Gollum wiki, but I think the tool we use to build it is deprecated.  Is having the raw markdown good enough for your purposes?

If this is in relation to the wiki being down for the last day or so – it’s back up now.

[Anonymous]

We don’t currently “build” an html version of the documentation — the version located at https://www.rosettacommons.org/docs/latest/Home is being served live by a Gollum wiki server (in no-edit mode) from the markdown documents in the Rosetta/documentation/ directory which comes with the Rosetta download.

You should be able to install a Gollum server locally to serve the pages for a webbrowser running on your machine. See https://github.com/gollum/gollum/wiki/Installation for more information on installation. (If you have administrator access, gollum should be availible through most Linux distributions.)

Note that we have some minor local modifications to the gollum server, so there may be some slight rendering differences between the online version and the locally served one.

[Anonymous]

Thank you for your answer.

[Author]

Posts