{"id":18378251,"url":"https://github.com/john-cd/cheatsheets","last_synced_at":"2025-04-06T22:32:16.786Z","repository":{"id":81066906,"uuid":"85785946","full_name":"john-cd/cheatsheets","owner":"john-cd","description":"John's Cheatsheets","archived":false,"fork":false,"pushed_at":"2024-03-08T02:15:09.000Z","size":5102,"stargazers_count":25,"open_issues_count":0,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-22T07:41:34.117Z","etag":null,"topics":["cheatsheet","markdown","mkdocs"],"latest_commit_sha":null,"homepage":"http://john-cd.com/cheatsheets","language":"Dockerfile","has_issues":false,"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/john-cd.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}},"created_at":"2017-03-22T04:46:22.000Z","updated_at":"2024-08-18T19:03:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"4d28947c-e231-41c2-9f5a-0752bb4c31ca","html_url":"https://github.com/john-cd/cheatsheets","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/john-cd%2Fcheatsheets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john-cd%2Fcheatsheets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john-cd%2Fcheatsheets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john-cd%2Fcheatsheets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/john-cd","download_url":"https://codeload.github.com/john-cd/cheatsheets/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247563901,"owners_count":20958971,"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":["cheatsheet","markdown","mkdocs"],"created_at":"2024-11-06T00:32:28.201Z","updated_at":"2025-04-06T22:32:16.222Z","avatar_url":"https://github.com/john-cd.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cheatsheets\n\n[John's Cheatsheets](https://john-cd.com/cheatsheets/)\n\n[John's Main Website](https://john-cd.com)\n\n## Repo structure\n\nThis website is generated using [MkDocs](https://mkdocs.org) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).\n\nThe source Markdown files are found in the `docs` folder. The resulting HTML / JS is found in `site`. There is also a `drafts` folder for Markdown files that are not ready for publication.\n\n`.devcontainer` contains the [Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) file and associated [Docker Compose](https://docs.docker.com/compose/) and [Dockerfile](https://docs.docker.com/reference/dockerfile/) setup. `github/workflows` contains the GitHub Action continuous deployment workflow.\n\n## Contributing\n\n### Install\n\nIf you use [Visual Studio Code](https://code.visualstudio.com/), install the [Dev Container extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). Otherwise, consider the [Dev Container CLI](https://containers.dev/supporting#devcontainer-cli). `Dev Container` allows you to edit and test the web site within a `Docker` container.\n\nAlternatively, install the required tools on your development machine directly, including [Python](https://www.python.org/), []\n\n```shell\npython -m pip install mkdocs --user\npython -m pip install mkdocs-material --user\n```\n\n### Basic MkDocs Commands\n\n- ``mkdocs new [dir-name]`` - Create a new project.\n- ``mkdocs serve`` - Start the live-reloading docs server.\n- ``mkdocs build`` - Build the documentation site.\n- ``mkdocs help`` - Print the help message.\n\nWithin a Dev Container, you may need to use `mkdocs serve --dev-addr 0.0.0.00:8000`.\n\n### Docker Compose\n\nTo test the Docker Compose setup, try\n\n```bash\ndocker compose -f .devcontainer/compose.yaml -f .devcontainer/compose.override.yaml up --build\ndocker compose down\n```\n\nand\n\n```bash\ndocker compose -f .devcontainer/compose.yaml -f .devcontainer/compose-ci.yaml up --build\ndocker compose down\n```\n\nYou may also build the image directly, e.g.: `docker build --file .devcontainer/Dockerfile --target dev --tag johncd/cheatsheets:latest .`\nTo push an image to your registry, use `docker push myregistry.com/myapp`.\n\nConsult Docker's [getting started](https://docs.docker.com/go/get-started-sharing/) docs for more detail on building and pushing.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohn-cd%2Fcheatsheets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohn-cd%2Fcheatsheets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohn-cd%2Fcheatsheets/lists"}