How to use these docs

These are the Integration Docs for HappyHorizon. This is a static page built with MkDocs Material.

The docs are written in Markdown and are git-hosted by Bitbucket. In the link in the right upper corner you can go to the Bitbucket repository.

Read more about Markdown here: https://www.markdownguide.org/basic-syntax/

Note that most Markdown editors do not support all features that this documentation supports. For example, the admonitions (notes, warnings, etc.) are not supported by most editors.

Committing Changes

After you change or add a page, just commit your changes to the Bitbucket repository. The changes will be automatically deployed to the docs website.

Changing pages

Simply click on the page you want to edit, and click the "Edit" button in the top right corner. This will open the page in Bitbucket, where you can edit it.

Adding a new page

The filestructure in the Bitbucket Repository is as follows: -> ./docs -> /Alumio-Concepts -> /Alumios-Architecture -> /schedulers.md -> /environment-variables.md -> /index.md -> /API-Concepts -> etc.

The 'first' level (in the example above '/Alumio-Concepts') is added to the menu as a tab.

You can add an 'index.md' there which is the main page for that tab. That's not required: if you leave out the 'index.md', Mkdocs will find the first available page in a subfolder to link to. You can also add other pages on that level, which will be grouped under the tab name.

Further levels will group in the left-hand menu.

Adding a page in Bitbucket is easy: just click on the Bitbucket icon in the upper right corner, click the three dots in Bitbucket (upper right corner), click 'Add File' and add in the full path (possible including /docs if needed).

Note that the H1 (#) is used as the title of the page.```

Supported Features

Codeblocks

You can add a single codeblock inline like this: This is a codeblock

You can add codeblocks like this:

This is a codeblock

You can add codeblocks with syntax highlighting like this:

{
    "This": "is a codeblock"
}

You can add linenumbers and a title of the file like this:

{
    "This": "is a codeblock"
}