{"id":13739455,"url":"https://github.com/LeeKaiXuan/PSS_Cookbook","last_synced_at":"2025-05-08T19:34:12.121Z","repository":{"id":196948177,"uuid":"697675358","full_name":"LeeKaiXuan/PSS_Cookbook","owner":"LeeKaiXuan","description":"Documentation for introducing the usage of PSS language.","archived":false,"fork":false,"pushed_at":"2023-11-03T03:12:49.000Z","size":893,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-23T10:20:08.287Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://leekaixuan.github.io/PSS_Cookbook/","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LeeKaiXuan.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":"2023-09-28T08:42:35.000Z","updated_at":"2024-08-03T04:06:52.963Z","dependencies_parsed_at":"2023-10-03T14:15:27.036Z","dependency_job_id":"4dc471d9-8713-49c2-b222-0a4c3481c2b3","html_url":"https://github.com/LeeKaiXuan/PSS_Cookbook","commit_stats":null,"previous_names":["leekaixuan/pss_cookbook"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeeKaiXuan%2FPSS_Cookbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeeKaiXuan%2FPSS_Cookbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeeKaiXuan%2FPSS_Cookbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeeKaiXuan%2FPSS_Cookbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LeeKaiXuan","download_url":"https://codeload.github.com/LeeKaiXuan/PSS_Cookbook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224758168,"owners_count":17364967,"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":"2024-08-03T04:00:34.128Z","updated_at":"2024-11-15T09:30:36.302Z","avatar_url":"https://github.com/LeeKaiXuan.png","language":"Dockerfile","funding_links":[],"categories":["PSS : Portable test and Stimulus Standard"],"sub_categories":[],"readme":"## PSS_Cookbook\nDocumentation for introducing the usage of PSS language.\n\n## Setup (Local Builder)\nIf you need to generate the website locally, please install MkDocs first. (Reference: https://squidfunk.github.io/mkdocs-material/getting-started/)\u003cbr\u003e\nI recommend using docker if you develop on Microsoft Windows (e.g., win10/win11).\n\nSteps of setup docker:\n1. Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop/).\n2. In Docker Desktop, search `squidfunk/mkdocs-material` on the top console then pull it.\n3. Clone this repo to a local directory.\n4. Go to the directory, and create a text file named `Dockerfile` without any extension.\n5. Paste the following context into `Dockerfile`:\n```Dockerfile\nFROM squidfunk/mkdocs-material\nRUN pip install mkdocs-macros-plugin\nRUN pip install mkdocs-glightbox\nRUN pip install mkdocs-git-revision-date-localized-plugin\n```\n6. Run PowerShell at the current path and enter following command:\n```bash\ndocker build -t squidfunk/mkdocs-material .\n```\n7. The older docker image can be deleted.\n\n## Previewing on Docker\nRun a PowerShell inside the local repo with following command:\n```bash\ndocker run --rm -it -p 8000:8000 -v .:/docs squidfunk/mkdocs-material\n```\nOnce the local MkDocs' server is ready, you can preview it on [```http://localhost:8000/```](http://localhost:8000/).\u003cbr\u003e\nThe server will auto-build the website every time any files under [docs/](docs) are updated.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLeeKaiXuan%2FPSS_Cookbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLeeKaiXuan%2FPSS_Cookbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLeeKaiXuan%2FPSS_Cookbook/lists"}