{"id":31298541,"url":"https://github.com/liatrio/csuc-workshop","last_synced_at":"2025-11-02T09:02:34.345Z","repository":{"id":310136677,"uuid":"1036121902","full_name":"liatrio/csuc-workshop","owner":"liatrio","description":"Workshop geared towards college students","archived":false,"fork":false,"pushed_at":"2025-09-11T21:12:11.000Z","size":167,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-11T23:57:56.101Z","etag":null,"topics":["docs","documentation"],"latest_commit_sha":null,"homepage":"https://csuc-workshop.liatr.io","language":"Makefile","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/liatrio.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,"zenodo":null}},"created_at":"2025-08-11T15:33:22.000Z","updated_at":"2025-09-11T21:11:33.000Z","dependencies_parsed_at":"2025-08-16T01:31:16.694Z","dependency_job_id":"b1873613-0b92-4e4d-a9f5-e1ac4586274d","html_url":"https://github.com/liatrio/csuc-workshop","commit_stats":null,"previous_names":["liatrio/csuc-workshop"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/liatrio/csuc-workshop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liatrio%2Fcsuc-workshop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liatrio%2Fcsuc-workshop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liatrio%2Fcsuc-workshop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liatrio%2Fcsuc-workshop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/liatrio","download_url":"https://codeload.github.com/liatrio/csuc-workshop/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liatrio%2Fcsuc-workshop/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276837203,"owners_count":25713343,"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","status":"online","status_checked_at":"2025-09-24T02:00:09.776Z","response_time":97,"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":["docs","documentation"],"created_at":"2025-09-25T00:01:44.166Z","updated_at":"2025-09-25T00:03:23.545Z","avatar_url":"https://github.com/liatrio.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# csuc-workshop\n\n[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge\u0026logo=MaterialForMkDocs\u0026logoColor=white)](https://squidfunk.github.io/mkdocs-material/)\n\nWorkshop geared towards college students\n\n\n## Local Development\n\n### Prerequisites\n\nThe following tools will need to be installed:\n\n\u003e OSX users with [Homebrew](https://brew.sh/) installed can install Poetry\n\u003e by running the command `make brew`.\n\n- [Make](https://www.gnu.org/software/make/): A build automation tool.\n- [Python](https://www.python.org/downloads/): The programming language used\n  for development.\n- [Poetry](https://python-poetry.org/docs/#installation): A tool for dependency\n  management in Python.\n\n### Running the Site Locally\n\nOur site is built using [mkdocs](https://www.mkdocs.org/), a static site\ngenerator optimized for project documentation. It features hot reloading,\nallowing immediate preview of changes, and can compile documentation into\nstatic assets for deployment.\n\nTo serve the site locally:\n\n- Use `make serve` to start a local server. Your changes can be viewed in\n  real-time at http://127.0.0.1:8000.\n- To build the documentation, run `make build`. This command generates static\n  files and stores them in the `./site` directory.\n\n### Install CSpell  for Code Spell Check\n\n[CSpell]() is a utility used to ensure words in code are spelled correctly.\nThere are a few ways it'll be run in this repository. \n\n1. Through GitHub actions\n\nWhen making a pull request, CSpell will automatically run as an action to\nprevent merge of any \"code\" that has misspelled words.\n\n2. Through Pre Commit Hooks\n\nIf you want it to run locally when writing code you can run it through a\npre-commit hook. Simply:\n* [install pre-commit](https://pre-commit.com/) via `brew install pre-commit`\n  or another means in the docs\n* `cd` to the root of this repo\n* run `pre-commit install` to install the pre-commit\n* once done editing, run `git commit` and it'll run the hooks to validate\n\n3. Through VSCode\n\nIf you're a VSCode user, you can install the [Code Spell\nChecker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)\nextension.\n\n\u003e Note: You made need to point the VSCode extension to the cspell.json file.\n\u003e If you have a word that is spelled correctly but is being detected as\n\u003e an invalid word, simply add the word to the list of words in the\n\u003e [cspell.json](./cspell.json) file.\n\n## Contributing\n\n* **Images** - To add an image, place it under the `docs/img` folder. To\n  reference the image use the syntax `![]()` e.g.\n  `![example-name](/assets/name-of-the-image)`\n* **Content** - To add content, create a new folder under `docs` e.g.\n  `docs/Example`. Under `docs/example` create a new markdown file, e.g.\n  `docs/example/example-content.md` . \n* **Page Titles** By default, the file name will serve as the title of the\n  page. You can override with a H1 header (`#`) or by [setting\n  meta-data](https://squidfunk.github.io/mkdocs-material/reference/#setting-the-page-title)\n  in the file.\n* **MkDocs Documentation** - [Official documentation](https://www.mkdocs.org/)\n* **Material Theme Documentation** - The\n  [README](https://github.com/squidfunk/mkdocs-material) in this repository\n  provides comprehensive instructions on installing MkDocs, configuring the\n  Material theme, and using its features and plugins.\n* **[Material Theme Customization][custom]** \n\n[custom]: https://squidfunk.github.io/mkdocs-material/customization/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliatrio%2Fcsuc-workshop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliatrio%2Fcsuc-workshop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliatrio%2Fcsuc-workshop/lists"}