{"id":18244361,"url":"https://github.com/flotiq/flotiq-docs","last_synced_at":"2025-07-26T03:08:21.644Z","repository":{"id":37398401,"uuid":"259332990","full_name":"flotiq/flotiq-docs","owner":"flotiq","description":"Flotiq Headless CMS documentation","archived":false,"fork":false,"pushed_at":"2025-07-24T09:20:40.000Z","size":359040,"stargazers_count":14,"open_issues_count":1,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-24T13:21:32.186Z","etag":null,"topics":["documentation","flotiq"],"latest_commit_sha":null,"homepage":"https://flotiq.com/docs/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flotiq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-04-27T13:36:57.000Z","updated_at":"2025-07-24T09:20:43.000Z","dependencies_parsed_at":"2023-10-16T19:01:25.295Z","dependency_job_id":"bc6c439c-751c-45d3-9e86-b06455878dac","html_url":"https://github.com/flotiq/flotiq-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/flotiq/flotiq-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flotiq","download_url":"https://codeload.github.com/flotiq/flotiq-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267109973,"owners_count":24037629,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-26T02:00:08.937Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","flotiq"],"created_at":"2024-11-05T09:16:25.172Z","updated_at":"2025-07-26T03:08:17.259Z","avatar_url":"https://github.com/flotiq.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://flotiq.com/\"\u003e\n    \u003cimg src=\"https://editor.flotiq.com/images/fq-logo.svg\" alt=\"Flotiq logo\" title=\"Flotiq\" align=\"right\" height=\"60\" /\u003e\n\u003c/a\u003e\n\nFlotiq documentation\n========================\n\nThis is the [Flotiq](https://flotiq.com) documentation. It's available online [here](https://flotiq.com/docs/). \n\nWe 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.\n\n## Prerequisites\n\nStarting the project with docker:\n* Installed docker\n\nStarting without docker:\n* Installed python\n* Installed git\n\n\n## Installation\n\nWith docker:\n`docker-compose up -d`\nIt will also start docs server.\n\nWithout docker:\n```bash\npip install -r requirements.txt\n```\n\nTo start server use:\n\n```bash\n# Use SOURCE_EDITOR_URL variable to point to speciffic dashboard url. By default, SOURCE_EDITOR_URL=https://editor.flotiq.com is used.\nbash .github/scripts/get-plugins-docs.sh # Pull dynamically generated plugin docs. \nmkdocs serve # Start devlopment server. Use --dirtyreload option to speed up reloading, but be aware, that this might break navigation on the preview.\n```\n\nAfter that, the documentation should be available on http://localhost:4000.\n\n## Troubleshooting \n\nIf during installation without docker you will encounter error with no git present, add 2 environment variables:\n* `GIT_PYTHON_GIT_EXECUTABLE` - with path to git e.g `/usr/bin/git`\n* `GIT_PYTHON_REFRESH` - with value `quiet` to suppress more git errors\n\n\n## Collaboration\n\nIf you wish to talk with us about this project, feel free to hop on [![Discord Chat](https://img.shields.io/discord/682699728454025410.svg)](https://discord.gg/FwXcHnX)  .\n   \nIf you found a bug, please report it in [issues](https://github.com/flotiq/flotiq-docs/issues).\n\nWe also welcome any PR with documentation improvements (or typo fixes ;) ).\n\n## Aliasing\nSome files are dynamically generated (e.g. all pages describing events and classes for plugin API). Those pages can be referred with an alias:\n\n```md\n\u003c!-- Refer to PluginInfo page --\u003e\n[[PluginInfo.md]] \n\n\u003c!-- Refer to PluginInfo page with an alternative name --\u003e\n[[PluginInfo.md|Page about PluginInfo class]] \n\n\u003c!-- Refer to header on PluginInfo page with an alternative name --\u003e\n[[PluginInfo.md#example-header|Example section on the page]]\n```\n\nYou can also add an alias to any existing page by dyfining it in the meta section of the markdown file:\n\n```md\n\u003c!-- Start of the markdown file --\u003e\nalias: some-example-alias\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflotiq%2Fflotiq-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflotiq%2Fflotiq-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflotiq%2Fflotiq-docs/lists"}