svaarala / duktape-wiki

Duktape Wiki
24 stars 14 forks source link

Duktape Wiki

Build Status

This is the repo for the official Duktape Wiki, http://wiki.duktape.org/.

Duktape Wiki is edited in the duktape-wiki repo, using pull requests to make edits. The Wiki is built into static HTML files using pandoc and hosted on wiki.duktape.org. Some pages are generated from outside sources, e.g. ConfigOptions page is generated using genconfig.py (developed in the Duktape main repo).

Building

The site is built with Linux, using Docker:

# Host needs a few commands like: make, git, zip.  Output site will appear
# in build/output/duktape-wiki-dist-html.zip.  You may need to use 'sudo make'
# depending on Docker setup.

$ make clean docker-images docker-build

Web server should redirect /index.html to Home.html.

License

Duktape Wiki is part of Duktape documentation and under the Duktape MIT license. When contributing to the Duktape Wiki you agree to license your contribution under this license.

Before contributing to the Wiki, create a pull request into the Duktape main repository to include your name in the AUTHORS.rst, under "Authors".

Contributing

See CONTRIBUTING.md.