ocsigen/html_of_wiki

Name: html_of_wiki

Owner: Ocsigen

Description: null

Created: 2017-09-11 15:25:22.0

Updated: 2018-04-19 08:16:53.0

Pushed: 2018-04-19 08:16:51.0

Homepage: null

Size: 2813

Language: OCaml

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Ocsigen documentation compiler

What is it?

Html_of_wiki makes it possible to update the new ocsigen.org Web Site on Github from wiki documentation of each project.

It takes the Wiki documentation of each project from repository ocsigen.org-data (which are themselves taken from each project repository).

It translates the wiki into html and saves the html in branch gh-pages of each project, and pushes this branch to github to make it available online.

Build instructions
 pin add html_of_wiki .
Doc
--help

gives command line options.

How to update the docs

Generate the HTML files using html_of_wiki (how):

./ocsigen.org-data
clone
index.wiki
push

how-clone will clone or update branch gh-pages of all repositories in ../ocsigen.org-repositories.

how index.wiki will generate the html documentation from wiki files accessible from index.wiki, and wiki files in ../ocsigen.org-data. The results is saved in branch gh-pages of each repository.

how-push pushes all changes on Github.

Main pages

The site main pages are hosted as organization github pages. The wiki sources are in repository ocsigen.org and then copied into directory ocsigen.github.io of repository ocsigen.org-data. The generated html files are in repository ocsigen.github.io (branch master).


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.