{"id":19911647,"url":"https://github.com/pyscript/docs","last_synced_at":"2025-10-15T02:04:34.729Z","repository":{"id":194149966,"uuid":"690211974","full_name":"pyscript/docs","owner":"pyscript","description":"The source code for the official documentation of PyScript.","archived":false,"fork":false,"pushed_at":"2025-03-11T12:08:19.000Z","size":4181,"stargazers_count":12,"open_issues_count":42,"forks_count":13,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-07T11:01:27.180Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.pyscript.net","language":"JavaScript","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/pyscript.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","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-11T18:49:02.000Z","updated_at":"2025-03-11T12:07:37.000Z","dependencies_parsed_at":"2023-09-29T17:24:41.565Z","dependency_job_id":"3be5449b-ef29-45f8-a0c9-ff5df360de06","html_url":"https://github.com/pyscript/docs","commit_stats":null,"previous_names":["pyscript/docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscript%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscript%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscript%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscript%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyscript","download_url":"https://codeload.github.com/pyscript/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252137545,"owners_count":21700237,"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-11-12T21:26:08.391Z","updated_at":"2025-10-15T02:04:29.667Z","avatar_url":"https://github.com/pyscript.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PyScript documentation\n\nWelcome to the PyScript documentation repository.\n\nThis source code becomes the official PyScript documentation hosted here:\n\n[https://docs.pyscript.net](https://docs.pyscript.net/)\n\nContribute prose and participate in discussions about the written support of\nPyScript and related topics.\n\n## Getting started\n\nBefore you start contributing to the documentation, it's worthwhile to\ntake a look at the general contributing guidelines for the PyScript project.\nYou can find these guidelines here\n[Contributing Guidelines](https://github.com/pyscript/pyscript/blob/main/CONTRIBUTING.md)\n\n## Setup\n\nThe `docs` directory in the pyscript repository contains a\n[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)\ndocumentation project. Material is a system that takes plaintext files\ncontaining documentation written in Markdown, along with static files like\ntemplates and themes, to build the static end result.\n\nTo setup the documentation development environment simply create a new\nvirtual environment, then `pip install -r requirements.txt` (from in the root\nof this repository).\n\n```sh\n# example of a simple virtual environment\n# creation from the root of this project\npython -m venv .\n./bin/pip install --upgrade setuptools\n./bin/pip install -r requirements.txt\n```\n\n## Build\n\nSimply run `mkdocs serve` or `./bin/mkdocs serve`.\n\n## Cross-referencing\n\nLink to other pages in the documentation by using the `{doc}` role. For\nexample, to link to the `docs/README.md` file, you would use:\n\n```markdown\n{doc}`docs/README.md`\n```\n\nCross-reference the Python glossary by using the `{term}` role. For example, to\nlink to the `iterable` term, you would use:\n\n```markdown\n{term}`iterable`\n```\n\nCross-reference functions, methods or data attributes by using the `{attr}` for\nexample:\n\n```markdown\n{py:func}`repr`\n```\n\nThis would link to the `repr` function in the python builtins.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyscript%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyscript%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyscript%2Fdocs/lists"}