{"id":19490837,"url":"https://github.com/geo-c/oct-coredocs","last_synced_at":"2026-06-11T13:31:33.265Z","repository":{"id":75693917,"uuid":"60930370","full_name":"geo-c/OCT-CoreDocs","owner":"geo-c","description":"The OCT-Core-Documentation written in Markdown, built with MkDocs","archived":false,"fork":false,"pushed_at":"2018-12-24T16:06:27.000Z","size":3412,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-02-25T19:43:31.410Z","etag":null,"topics":["documentation-generator","mkdocs"],"latest_commit_sha":null,"homepage":"http://giv-oct.uni-muenster.de:8080/docs/","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/geo-c.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2016-06-11T22:22:52.000Z","updated_at":"2018-12-24T16:06:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"43b4c049-1677-484f-8d2b-b393bc75b546","html_url":"https://github.com/geo-c/OCT-CoreDocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/geo-c/OCT-CoreDocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCT-CoreDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCT-CoreDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCT-CoreDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCT-CoreDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geo-c","download_url":"https://codeload.github.com/geo-c/OCT-CoreDocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCT-CoreDocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34201840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"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-generator","mkdocs"],"created_at":"2024-11-10T21:14:30.699Z","updated_at":"2026-06-11T13:31:33.233Z","avatar_url":"https://github.com/geo-c.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OCT-Core-Docs\nThe OCT-Core-Documentation written in Markdown, built with MkDocs\n\n***\n\n### Build-process\n\n* You need Python (2.7.2) and the Python Package Index (1.5.2) to build the documentation. Check if your operating-system provides it already:\n\n```\npython --version\npip --version\n```\n\n* This documentation uses [MkDocs](http://www.mkdocs.org/), so that the documentation can be written in Markdown. **Cheat cheets** for Markdown can be found here:\n\t* [https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)\n\t* [https://daringfireball.net/projects/markdown/](https://daringfireball.net/projects/markdown/)\n\n* Install MkDocs with the following command:\n\n```\npip install mkdocs\n```\n\n* Clone this repository to a local-repository and build the documentation with the following command:\n\n```\nmkdocs build\n```\n\n**Attention**: If some problems occur during the build-process, you can also try to re-build the documentation with the following command:\n```\nmkdocs build --clean\n```\n\n* If you want to add new pages to this documenation, create a new `.md`-Files in folder: `docs/`\n**Hint**: If you want to add sections, create a new folder, like this: `docs/NewSection` and create your new `.md`-files in this folder\n\n* Before building, don't forget to add your new page(s) and sections in the `mkdocs.yml`-file. Please find an example at the end of this page: `NewSection` and `newSinglePage.md`\n\n```\n- Home: index.md\n- Installations:\n    - Nodejs: installations/nodejs.md\n    - Bower: installations/bower.md\n- About:\n    - Repositories: about/repositories.md\n    - Contributers: about/contributers.md\n- NewSection:\n    - newPage: newSection/newPage.md\n- newSinglePage.md: newSinglePage.md\n```\n\n* Build the documentation with the command above (see: 4.). All `.md`-files will be generated into `.html`-files in the folder `site/`.\n**Hint**: For automatically building, you can use the following command, to start the built-in-MkDocs-Server:\n\n```\nmkdocs serve\n```\nOpen a new browser-tab and go to [http://127.0.0.1:8000/](http://127.0.0.1:8000/).\n\nFor more information about MkDocs, please have a look into their documentation [http://www.mkdocs.org/](http://www.mkdocs.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeo-c%2Foct-coredocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeo-c%2Foct-coredocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeo-c%2Foct-coredocs/lists"}