{"id":24501162,"url":"https://github.com/team997coders/software-resources","last_synced_at":"2025-03-15T07:24:41.657Z","repository":{"id":273604968,"uuid":"689776848","full_name":"Team997Coders/software-resources","owner":"Team997Coders","description":"Software documentation for Spartan Robotics.","archived":false,"fork":false,"pushed_at":"2023-09-10T21:28:49.000Z","size":794,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-21T22:31:00.559Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://team997coders.github.io/software-resources/","language":"Python","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/Team997Coders.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":"2023-09-10T21:27:39.000Z","updated_at":"2023-09-10T21:38:38.000Z","dependencies_parsed_at":"2025-01-21T22:31:04.826Z","dependency_job_id":"4c08c6d5-7ea3-4b90-badc-b8fb989fab08","html_url":"https://github.com/Team997Coders/software-resources","commit_stats":null,"previous_names":["team997coders/software-resources"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Team997Coders%2Fsoftware-resources","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Team997Coders%2Fsoftware-resources/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Team997Coders%2Fsoftware-resources/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Team997Coders%2Fsoftware-resources/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Team997Coders","download_url":"https://codeload.github.com/Team997Coders/software-resources/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243697835,"owners_count":20333022,"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":[],"created_at":"2025-01-21T22:25:33.177Z","updated_at":"2025-03-15T07:24:41.651Z","avatar_url":"https://github.com/Team997Coders.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spartan Robotics Software Resources\nSoftware documentation for Spartan Robotics.\n\n## [View on GitHub Pages!](https://team997coders.github.io/software-resources/)\n\n\u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-sa/4.0/\"\u003e\u003cimg alt=\"Creative Commons License\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by-sa/4.0/88x31.png\" /\u003e\u003c/a\u003e\u003cbr /\u003eThis work is licensed under a \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-sa/4.0/\"\u003eCreative Commons Attribution-ShareAlike 4.0 International License\u003c/a\u003e.\n\n## Contributing\nThis project uses [MkDocs](https://www.mkdocs.org/) with the [Material](https://squidfunk.github.io/mkdocs-material/) theme. Both sites contain plenty of documentation information.\n\nThe docs are written in Markdown, which is very close to plain text and easy to pick up. [This manual](https://www.markdownguide.org/) is an excellent reference source. Be aware that a few extended syntax features may not actually work with MkDocs.\n\n### Working Locally\nIt's a good idea to check the rendering of your documentation before committing it. A local setup can be done pretty easily, thankfully.\n\nStart by installing the python requirements:\n```\npip install -r requirements.txt\n```\n\nAnd then render an automatically-refreshing output to `127.0.0.1.8000`:\n```\nmkdocs serve\n```\n\nIt's that easy!\n\n### Adding New Pages\nNew pages can be added by creating a .md file somewhere in the `docs` directory. Follow the pattern shown at the bottom of `mkdocs.yml` to add them to the navigation sidebar.\n\n### MathJax/LaTeX\nMath expressions are supported, using the MathJax Javascript library. LaTeX is a complicated beast, but we only use its math expression syntax. [MathJax's LaTeX documentation](https://docs.mathjax.org/en/latest/input/tex/index.html) is a good place to start.\n\n### Mermaid2\nMermaid is a very slick library for generating charts, using similar syntax to Markdown. Documentation on using Mermaid in MkDocs can be found [here](https://mkdocs-mermaid2.readthedocs.io/en/latest/), and general Mermaid information at [the official site](https://mermaid.js.org/community/n00b-overview.html).\n\n### Macros\nMarkdown doesn't support a few things that we want to do in our documentation, notably the embedded compiler and spoiler tags for code. Instead, we have to use raw HTML. Macros help with this process-- instead of manually adding all the tags ourselves, we can call a macro which applies the proper tags. The macros are processed before Markdown is turned into HTML and before HTML is rendered, so the generated text is just as real to them as anything else.\n\nMacros are written in Python, and live inside the main.py file. That file should be formatted with [black](https://github.com/psf/black) (`black .`).\n\nInvoking a macro is done with `{{ macroName(arg1, arg2, ...)}}`. Further documentation can be found [here](https://mkdocs-macros-plugin.readthedocs.io/en/latest/pages/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteam997coders%2Fsoftware-resources","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteam997coders%2Fsoftware-resources","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteam997coders%2Fsoftware-resources/lists"}