roadkill icon indicating copy to clipboard operation
roadkill copied to clipboard

Pushing HTML to the wiki

Open richard-bibb opened this issue 8 years ago • 3 comments

Hi, I was just wondering if it wsa possible to push content to the roadkill wiki. I was thinking of using roadkill as an intranet site for all of our code documentation (generated by sphinx). Is this possible?

richard-bibb avatar Sep 01 '17 08:09 richard-bibb

Can you provide a bit more detail? You can put HTML in, as long as you're using the Markdown syntax. You'll to configure which HTML elements you allow otherwise they will be stripped off.

If you want to automatically do it, there's a few ways of putting data into the wiki via C# and the rest api.

yetanotherchris avatar Sep 03 '17 18:09 yetanotherchris

Hi, yes of course. The project I work on are written in python and use Sphinx to generate the associated documentation in HTML. I would like to be able to upload this documentation to a predefined stub on the WIki (i.e. I would write some a higher level "Welcome to the company software documentation" page and then upload the underlying documentation for each project

richard-bibb avatar Sep 04 '17 09:09 richard-bibb

That sounds easy enough, once you've created the stub pages. You can import directly into the roadkill_pages table in your database as the first step, creating a version each time you do. Make sure you use Markdown however, as that supports HTML inline (and is what Roadkill 3 will only support)

yetanotherchris avatar Sep 05 '17 07:09 yetanotherchris