{"id":19490836,"url":"https://github.com/geo-c/octdevcorner","last_synced_at":"2025-02-25T19:43:10.485Z","repository":{"id":75693938,"uuid":"51771819","full_name":"geo-c/OCTDevCorner","owner":"geo-c","description":"Project-Documentation written in Markdown with MkDocs","archived":false,"fork":false,"pushed_at":"2016-03-31T07:55:30.000Z","size":78,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-08T08:45:44.049Z","etag":null,"topics":["documentation-tool","mkdocs","open-source","python"],"latest_commit_sha":null,"homepage":"http://giv-oct2.uni-muenster.de/dev-corner","language":null,"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-02-15T17:16:48.000Z","updated_at":"2018-01-11T12:13:08.000Z","dependencies_parsed_at":"2023-06-07T09:36:04.810Z","dependency_job_id":null,"html_url":"https://github.com/geo-c/OCTDevCorner","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCTDevCorner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCTDevCorner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCTDevCorner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geo-c%2FOCTDevCorner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geo-c","download_url":"https://codeload.github.com/geo-c/OCTDevCorner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240738087,"owners_count":19849546,"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","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-tool","mkdocs","open-source","python"],"created_at":"2024-11-10T21:14:30.613Z","updated_at":"2025-02-25T19:43:10.464Z","avatar_url":"https://github.com/geo-c.png","language":null,"readme":"# Dev-Corner\n\nDocumentation written 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 your 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- Data:\n    - Collection: data/collection.md\n    - Storage: data/storage.md\n    - Retrieval: data/retrieval.md\n    - Analysis: data/analysis.md\n    - Visualization: data/visualization.md\n- About:\n    - Licenses: about/licenses.md\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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeo-c%2Foctdevcorner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeo-c%2Foctdevcorner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeo-c%2Foctdevcorner/lists"}