ECMA-419 Documentation

Guides and API docs for the ECMA-419 specification, a.k.s JS on embedded systems. While the spec is meant for implementers and technical authors, this content should help introduce "JS on Things" and provide high-level examples.

🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
pnpm install	Installs dependencies
pnpm run dev	Starts local dev server at localhost:4321
pnpm run build	Build your production site to ./dist/
pnpm run preview	Preview your build locally, before deploying
pnpm run astro ...	Run CLI commands like astro add, astro check
pnpm run astro -- --help	Get help using the Astro CLI

👀 Want to learn more?

Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.

Contributing

Thank you for your interest in contributing to the ECMA-419 documentation site! 🎉

Authors of contributions from non-Ecma member organizations must sign the Contributor License Agreement

To get started:

1. Fork this repo
2. Edit the page using the GitHub UI, the github.dev editor, or your preferred local text editor like VSCode or Neovim.
   • If using a local text editory, you'll need to clone the new fork locally
3. Create a new branch for your changes: git switch -c docs-update (you can name it "docs-update" or whatever you'd like)
4. Commit your changes
5. Push your changes to your fork
6. Create a pull request to EcmaTC53/docs:main
7. Wait for review.

For new pages, see src/contents/docs/api/_example-template.md for the recommended structure for API documentation.

If you would like to preview your changes:

1. Make sure Node.js and pnpm are available in your development environment.
2. Install the project dependencies: pnpm install
3. Run the development server, which will reload when any changes are made to the documentation pages: pnpm run dev
4. View the running site at http://localhost:4321