Skip to content

About

Developer documentation for Halone: halone.dev

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

4 Commits

Folders and files

Repository files navigation

Halone docs

The developer documentation for Halone, served at halone.dev: the web SDK, the native plugin SDK, and adding support for new glasses. Built with VitePress.

pnpm install
pnpm docs:dev
pnpm docs:build
pnpm docs:preview

docs:dev serves the site with hot reload, and docs:build writes it to docs/.vitepress/dist, which docs:preview serves.

The web SDK's API reference under docs/web/reference/ is generated by TypeDoc from the published @halone/sdk type declarations each time the site is built or served (pnpm api). To document a new SDK release, bump @halone/sdk in package.json.

Pushes to main deploy to GitHub Pages.

License

MIT.

About

Developer documentation for Halone: halone.dev

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors