{"id":26657269,"url":"https://github.com/crowdsalat/technotes","last_synced_at":"2025-04-11T11:54:39.421Z","repository":{"id":50302937,"uuid":"216250620","full_name":"CrowdSalat/technotes","owner":"CrowdSalat","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-10T13:59:14.000Z","size":2882,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-10T14:59:15.619Z","etag":null,"topics":["gh-pages","mkdocs"],"latest_commit_sha":null,"homepage":"http://crowdsalat.github.io/technotes","language":null,"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/CrowdSalat.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":"docs/security_scanner.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-10-19T18:15:00.000Z","updated_at":"2025-04-10T13:58:55.000Z","dependencies_parsed_at":"2023-02-16T17:45:50.597Z","dependency_job_id":"b5954087-a2a6-4cca-8987-2252aa3bd954","html_url":"https://github.com/CrowdSalat/technotes","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/CrowdSalat%2Ftechnotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdSalat%2Ftechnotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdSalat%2Ftechnotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrowdSalat%2Ftechnotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrowdSalat","download_url":"https://codeload.github.com/CrowdSalat/technotes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248391292,"owners_count":21095987,"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":["gh-pages","mkdocs"],"created_at":"2025-03-25T08:19:31.289Z","updated_at":"2025-04-11T11:54:39.397Z","avatar_url":"https://github.com/CrowdSalat.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/CrowdSalat/technotes)\r\n\r\n# technotes\r\n\r\nBuilds every time you push a change to the master branch. \r\n\r\nUses the Github Action [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs) to build the page and put the build artifacts to [gh-pages](https://github.com/CrowdSalat/technotes/tree/gh-pages) branch. Afterwards [github pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages) is used to host the page under: [**http://crowdsalat.github.io/technotes**](http://crowdsalat.github.io/technotes).\r\n\r\n## Install\r\n\r\n``sudo pip3 install mkdocs``\r\n\r\n``sudo pip3 install mkdocs-material``\r\n\r\nsudo might be necessary to add mkdocs on the path. If you want to change color or the navigation refer to [mkdocs martial setup guide](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/).\r\n\r\n## Commands\r\n\r\n* `mkdocs new [dir-name]` - Create a new project.\r\n* `mkdocs serve` - Start the live-reloading docs server.\r\n* `mkdocs build` - Build the documentation site.\r\n* `mkdocs help` - Print this help message.\r\n* `mkdocs gh-deploy --clean` - Builds the site and push the generated artefacts to gh-pages branch of the repo\r\n\r\n## Project layout\r\n\r\n    mkdocs.yml    # The configuration file.\r\n    docs/\r\n        index.md  # The documentation homepage.\r\n        ...       # Other markdown pages, images and other files.\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdsalat%2Ftechnotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrowdsalat%2Ftechnotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdsalat%2Ftechnotes/lists"}