Skip to content

About

TomlSmith website and documentation

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

TomlSmith Website

English | 简体中文

The homepage and user documentation for TomlSmith.

The playground deploys independently from the playground repository through GitHub Pages.

Develop

Install Node.js 22.12 or newer and pnpm, then:

pnpm install
pnpm dev

pnpm build writes the production site to doc_build/; pnpm preview serves that build locally.

Content guidelines

  • Describe what a user can do before explaining how the project is implemented.
  • Keep claims concrete: name the behavior, limitation, input, or measurement behind them.
  • Put dependency versions, checksums, and test-runner details in the relevant reference page instead of repeating them on the homepage.
  • Update the English and Simplified Chinese pages together, preserving meaning rather than translating word for word.

Deploy

Pushing to main builds and publishes the site after Settings → Pages → Source: GitHub Actions has been enabled once on the repository.

License

MIT. See LICENSE.

About

TomlSmith website and documentation

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages