Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vedastro.github.io

Source for the VedAstro API documentation site, published at vedastro.github.io.

This is a generated static site, not hand-written. scripts/build.mjs fetches the live method list from GET https://api.vedastro.org/api/ListAllCalls (652+ methods, self-described via XML doc comments) and generates one page per method, plus category indexes, a search index, and a getting-started guide.

Build locally

node scripts/build.mjs
# output in dist/

Deploy

A GitHub Actions workflow (.github/workflows/deploy.yml) rebuilds and redeploys to GitHub Pages on every push to main, daily on a schedule (to pick up new/changed API methods automatically), and on manual dispatch.

Structure

  • scripts/build.mjs — fetches method metadata, generates dist/
  • scripts/categorize.mjs — keyword-heuristic category classifier (the API has no built-in taxonomy)
  • scripts/layout.mjs — shared HTML page shell
  • static/ — CSS, client-side search, and the "Try it" live-call widget, copied into dist/static/

See vedastro-api-examples for runnable sample code and the core API gotchas (response envelope, time format, auth).

About

Comprehensive, auto-generated documentation for all 650+ VedAstro API methods.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages