Documentation service for on-site documentation and tutorials for shipyards features.
The documentation service supplies the documentation of Shipyard, pages are supplied as Markdown files.
Each topic is reachable by visiting /documentation/[category]-[topic].
The documents directory contains of subdirectories for each category, every category directory contains serveal Markdown files.
Follow the following rules to create new content, and link the new files in the main react file.
If you want to add a new Category, add a new directory in ./documents, with a descriptive category name. Do not create a file called "Home.md", since the categories homepage will be automatically generated.
To add a new Topic, create a markdown file in the category directory it should be part of.
If you need to add an image to your topic, it can be placed in ./app/assets/images. After building, it can be found in ./public/images/. Please use Reference style image placement in Markdown.
Add your new Category or Topic to the ./app/targets.js file, and follow the already existing entries as a guideline. The rest will be done automatically.
(Documentation HOME is not a markdown page)
- Installation
- Home
- Configuration
- Home
- Quickstart
- Home
please refer to the Markdown-Cheatsheet by Adam Pritchard for Markdown reference.
This project is released under the Apache version 2 license.