https://github.com/flotiq/flotiq-docs
Flotiq documentation
https://github.com/flotiq/flotiq-docs
documentation flotiq
Last synced: 3 months ago
JSON representation
Flotiq documentation
- Host: GitHub
- URL: https://github.com/flotiq/flotiq-docs
- Owner: flotiq
- Created: 2020-04-27T13:36:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-17T10:03:57.000Z (5 months ago)
- Last Synced: 2025-02-18T13:38:12.415Z (5 months ago)
- Topics: documentation, flotiq
- Language: HTML
- Homepage: https://flotiq.com/docs/
- Size: 280 MB
- Stars: 14
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Flotiq documentation
========================
This is the [Flotiq](https://flotiq.com) documentation. It's available online [here](https://flotiq.com/docs/).
We are improving our documentation along as Flotiq improves. We are trying our best to keep it as up to date and clear as it is possible. If you wish to help us with that task - PRs are welcome.
## Prerequisites
Starting the project with docker:
* Installed docker
Starting without docker:
* Installed python
* Installed git
## Installation
With docker:
`docker-compose up -d`
It will also start docs server.
Without docker:
```bash
pip install -r requirements.txt
```
To start server use:
```bash
# Use SOURCE_EDITOR_URL variable to point to speciffic dashboard url. By default, SOURCE_EDITOR_URL=https://editor.flotiq.com is used.
bash .github/scripts/get-plugins-docs.sh # Pull dynamically generated plugin docs.
mkdocs serve # Start devlopment server. Use --dirtyreload option to speed up reloading, but be aware, that this might break navigation on the preview.
```
After that, the documentation should be available on http://localhost:4000.
## Troubleshooting
If during installation without docker you will encounter error with no git present, add 2 environment variables:
* `GIT_PYTHON_GIT_EXECUTABLE` - with path to git e.g `/usr/bin/git`
* `GIT_PYTHON_REFRESH` - with value `quiet` to suppress more git errors
## Collaboration
If you wish to talk with us about this project, feel free to hop on [](https://discord.gg/FwXcHnX) .
If you found a bug, please report it in [issues](https://github.com/flotiq/flotiq-docs/issues).
We also welcome any PR with documentation improvements (or typo fixes ;) ).
## Aliasing
Some files are dynamically generated (e.g. all pages describing events and classes for plugin API). Those pages can be referred with an alias:
```md
[[PluginInfo.md]]
[[PluginInfo.md|Page about PluginInfo class]]
[[PluginInfo.md#example-header|Example section on the page]]
```
You can also add an alias to any existing page by dyfining it in the meta section of the markdown file:
```md
alias: some-example-alias