Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Transon documentation site

Interactive docs and playground for transon, deployed at https://transon-org.github.io/.

Branches

Branch Purpose
master Source — React app, public/ assets, TypeScript

Pushes to master deploy automatically via GitHub Actions (.github/workflows/deploy.yml). GitHub Pages must be configured to GitHub Actions (Settings → Pages → Build and deployment → Source).

Development

yarn install
yarn start

Open http://localhost:3000. The playground needs PyScript to load transon from PyPI in the browser; local dev behaves the same as production.

Release

Pushes to master trigger an automatic deploy: the workflow runs yarn build, uploads the artifact, and publishes with actions/deploy-pages. You can also re-run the workflow manually from the Actions tab.

After deploy, verify https://transon-org.github.io/ loads the docs (not a blank page). PyScript assets are pinned in public/index.html — the /latest/ CDN path no longer exists.

How it works

  • React renders rule docs and examples.
  • PyScript runs public/script.py, which imports transon and calls js.init() with JSON from transon.docs.get_all_docs().
  • Example editors call transform(template, data) bridged from Python via pyscript.interpreter.globals.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages