This repository contains the technical documentation for the WollMux project.
The documentation is written in Markdown format, that can be converted to HTML, PDF and several eBook formats with GitBook.
-
Clone the repository
git clone https://github.com/WollMux/WollMuxHandbuch.git -
Switch to the GitBook folder
cd WollMuxHandbuch -
Install Node.js dependencies
npm install -
Install Gitbook plugins
gitbook install -
Build the documentation
-
HTML
gitbook build -
PDF
gitbook pdf . ./wollmux-handbuch.pdf -
eBook
gitbook mobi . ./wollmux-handbuch.mobigitbook epub . ./wollmux-handbuch.epub
-
Currently the documentation is primarily written in German. An incomplete version in English has been started in the branch 'language-en'.
The Markdown files can be edited with any plain text editor. Specialized editors with Markdown support can be found on the internet for free.
GitBook contains a web server, that can be used to preview the generated HTML while editing.
The server is started with Grunt.
grunt
This command will compile the Markdown to HTML and start the GitBook server. Any time a file in the folder markdown is changed, the files are recompiled and the server is restarted.
The server listens on the port 4000. To see the HTML document open your browser on http://localhost:4000/Hauptseite.html.
If your browser has a plugin for LiveReload installed, the website is automatically refreshed.
The task deploy recompiles the documentation and pushes the resulting web-site
into the branch gh-pages.
git checkout master
grunt deploy [--tag="<tag>"] [--message="<commit-message>"]
-
tag: Creates a tag on the branch
gh-pages. Default: no tag is created. -
message: Commit message. Default: "Neue Version."
Link to generated documentation.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
