docs: rewrite typst-docs-web README in English #275
Conversation
3w36zj6
changed the title
3w36zj6
force-pushed
the
feature/rewrite-website-readme
branch
from
082b31f to
a2468e5
Compare
3w36zj6
force-pushed
the
feature/rewrite-website-readme
branch
from
a2468e5 to
3429602
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR rewrites the website README from Japanese to English, providing comprehensive documentation for the typst-docs-web project. The changes transform a minimal Japanese README into a detailed English guide covering setup, configuration, and usage.
Key changes:
- Complete rewrite from Japanese to English
- Added detailed setup instructions with toolchain requirements
- Expanded documentation with configuration examples and project structure
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Hi @YDX-2147483647 @Its-Just-Nans |
3w36zj6
changed the title
There was a problem hiding this comment.
You could also make the schema available on https://www.schemastore.org/
https://github.com/SchemaStore/schemastore
^^
I just learned about schemastore.org for the first time. This is not a widely known or "standard" application, so I don't think it is necessary at this time. |
website/typst-docs-web/README.md
Outdated
| <img src="./images/preview.png" alt=""> | ||
| </div> | ||
|
|
||
| A generator that builds a website from a documentation JSON file generated by typst-docs. |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
website/typst-docs-web/README.md
Outdated
|
|
||
| ```json | ||
| { | ||
| "$schema": "/path/to/typst-docs-web/metadata.schema.json", |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| bun run test | ||
| ``` | ||
|
|
||
| ## Maintainers |
There was a problem hiding this comment.
Could we note the version of typst-docs json somewhere? For example:
The JSON structure generated by typst-docs is not stable.
This project is confirmed to be compatible with typst-docs from v0.13.1 to the dev version on 2025-09-18.
Other versions are usually compatible as well, but they have not been tested carefully.
The typst-docs says the JSON structure is not stable and may change at any time, and it is likely to change soon (because of typst/typst#6922).
There was a problem hiding this comment.
I think it's a good idea to clearly state the supported version.
However, since we don't want to update the README too frequently, I believe it's better to mention only the released versions.
The best approach would be to ensure compatibility by running documentation generation tests for the supported versions in CI.
3w36zj6
force-pushed
the
feature/rewrite-website-readme
branch
from
6ffdf6c to
c19540f
Compare
cf. #233