{"id":32444386,"url":"https://github.com/typst-community/typst-docs-web","last_synced_at":"2025-10-26T03:38:57.734Z","repository":{"id":315858406,"uuid":"1052425516","full_name":"typst-community/typst-docs-web","owner":"typst-community","description":"Build a website from the documentation JSON file generated by typst-docs.","archived":false,"fork":false,"pushed_at":"2025-10-25T14:46:52.000Z","size":440,"stargazers_count":7,"open_issues_count":11,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-25T16:28:40.243Z","etag":null,"topics":["documentation","i18n","ssg","typst","typst-docs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/typst-community.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-08T03:19:38.000Z","updated_at":"2025-10-25T14:46:56.000Z","dependencies_parsed_at":"2025-09-21T08:38:21.449Z","dependency_job_id":"db75fad3-559c-4ba6-b0b8-97ceecc76cac","html_url":"https://github.com/typst-community/typst-docs-web","commit_stats":null,"previous_names":["typst-jp/typst-docs-web"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/typst-community/typst-docs-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typst-community%2Ftypst-docs-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typst-community%2Ftypst-docs-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typst-community%2Ftypst-docs-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typst-community%2Ftypst-docs-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typst-community","download_url":"https://codeload.github.com/typst-community/typst-docs-web/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typst-community%2Ftypst-docs-web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281055245,"owners_count":26436347,"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-10-26T02:00:06.575Z","response_time":61,"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":["documentation","i18n","ssg","typst","typst-docs"],"created_at":"2025-10-26T03:38:56.407Z","updated_at":"2025-10-26T03:38:57.723Z","avatar_url":"https://github.com/typst-community.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typst-docs-web\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./images/preview.png\" alt=\"\"\u003e\n\u003c/div\u003e\n\nBuild a website from the documentation JSON file generated by [typst-docs](https://github.com/typst/typst/blob/main/docs/Cargo.toml#L2).\n\n## Required toolchains\n\n- [Node.js](https://nodejs.org/)\n- [Bun](https://bun.sh/)\n\nUsing [mise](https://mise.jdx.dev/) is recommended, as it enables central management of all the toolchains required for both the SSG and the upstream typst-docs.\n\n```toml\n# mise.toml\n[tools]\nrust = \"1.83.0\" # set required version for typst-docs\nnode = \"22.11.0\"\nbun = \"1.2.21\"\n```\n\n## Setup\n\n\u003e [!NOTE]\n\u003e The JSON structure generated by typst-docs is not stable and may change at any time. This project is confirmed to be compatible with typst-docs [v0.13.1](https://github.com/typst/typst/tree/v0.13.1). Other versions are usually compatible as well, but they have not been tested carefully.\n\nThe typst-docs CLI outputs the static files required for building the documentation. Place the JSON file and assets generated by typst-docs in the `/public/` directory. In most use cases, symbolic links are convenient.\n\n```sh\n# Run in the root directory of typst/typst repository\ncargo run --package typst-docs -- --assets-dir assets --out-file docs.json --base /docs/\n```\n\n```plaintext\npublic\n├── assets ⇒ /path/to/typst/assets\n└── docs.json ⇒ /path/to/typst/docs.json\n```\n\nCreate `/public/metadata.json` and describe the metadata for the documentation website. For details on each property, refer to the JSON schema. For example:\n\n```json\n{\n  \"$schema\": \"../metadata.schema.json\",\n  \"language\": \"ja-JP\",\n  \"version\": \"0.13.1\",\n  \"typstOfficialUrl\": \"https://typst.app\",\n  \"typstOfficialDocsUrl\": \"https://typst.app/docs/\",\n  \"githubOrganizationUrl\": \"https://github.com/typst-jp\",\n  \"githubRepositoryUrl\": \"https://github.com/typst-jp/docs\",\n  \"discordServerUrl\": \"https://discord.gg/9xF7k4aAuH\",\n  \"originUrl\": \"https://typst-jp.github.io/\",\n  \"basePath\": \"/docs/\",\n  \"displayTranslationStatus\": true\n}\n```\n\n`/public/translation-status.json` is used to manage the translation progress and the classification of original content. This file is automatically updated when running the SSG, so manual editing is not necessary.\n\nThe image provided in `public/favicon.png` is used as the favicon for the documentation website. Currently, this image is also used as the OGP `og:image`, so please provide it in PNG format.\n\n## Commands\n\nAfter installing dependencies with Bun, the following commands are available:\n\n```sh\nbun install --frozen-lockfile\n```\n\n### Develop\n\n\u003e [!NOTE]\n\u003e The full-text search index is generated by [pagefind](https://pagefind.app/), but since the output directory is set to `/dist/`, full-text search functionality is currently unavailable in the development server. For developing search-related features, please execute `bun run build` first, then use `bun run preview` to inspect the built output.\n\n```sh\nbun run dev\n```\n\n### Build\n\n```sh\nbun run build\n```\n\n### Preview\n\n```sh\nbun run preview\n```\n\n### Biome check\n\n```sh\n# Check code style\nbun run check\n\n# Apply automatic code fixes\nbun run check:write\n```\n\n### Type check\n\n```sh\nbun run type-check\n```\n\n### Test\n\n```sh\nbun run test\n```\n\n## Maintainers\n\n- [@3w36zj6](https://github.com/3w36zj6)\n\n## License\n\nThis project is derived from [typst/typst](https://github.com/typst/typst) and is licensed under the Apache-2.0 license.\n\nNon-OSS assets distributed by the Typst web app are not included in this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypst-community%2Ftypst-docs-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypst-community%2Ftypst-docs-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypst-community%2Ftypst-docs-web/lists"}