---
# System prepended metadata

title: Dev - GitSupervisor

---

# Dev - GitSupervisor

## Documentation

You will find the documentation content at the root of the repository in the `documentation` folder.

### Folder Structure

#### The `src` folder

In this folder you can add, edit or remove the markdown content. 
The `index.md` file indexes the links to the other markdown files and groups them in two categories, *Overview* for the main features of the application and *Specific Features* for the side features.
When you add a new file don't forget to put a link in the proper category :

```
* [New Page](new_page.md)
```

and to add links in the footer to facilitate the navigation between the documentation pages :

```
[&larr; previous_page](previous_page.md) | [Back to the Table of Contents](index.md) | [next_page &rarr;](next_page.md)
```

If you need to use images, put them in the `src/images` folder and name them explicitely.

#### The `site` folder

This folder contains the HTML files generated from the markdown files in the `src` folder.

### Generating the HTML content

To generate the HTML content you need to execute the `generateDoc.sh` script at the root of the documentation folder.

What does this script do ? 

* deletes the previously generated HTML files and copied images

```shell=bash
rm -rf site
```

* generates new ones

```shell=bash
generate-md --layout github --input src --output site
```

* copies the `images` folder 

```shell=bash
cp -R src/images site/
```
