Skip to content

transon-org/transon-org.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 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
gh-pages Release — built static site served by GitHub Pages

Do not edit gh-pages by hand. Deploy from master with npm run deploy.

Development

npm install
npm 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

npm run deploy

This runs npm run build (via predeploy), then pushes the build/ folder to the gh-pages branch with gh-pages.

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

No releases published

Packages

 
 
 

Contributors