Eld Docs

Documentation site for the Eld blockchain, built with Docusaurus.

This repository is the public documentation site only — not the Eld protocol, node software, or SDKs. For the marketing site and live chain, see eld.network.

Live site: https://docs.eld.network

Prerequisites

• Node.js >= 20

Local development

npm install
npm start

This starts a local dev server at http://localhost:3000. Most changes reload automatically.

Build

npm run build

Static output is written to the build/ directory.

To preview the production build locally:

npm run serve

CI

npm run ci

Runs Prettier, ESLint, markdownlint, Vitest (Navbar/Footer), npm audit on production deps (fails on critical+; Docusaurus still reports known unfixed highs), and a production build. CI also runs lychee against Markdown external links (npm run links locally if lychee is installed).

Releasing

Merges to main (and work on feature branches) do not deploy the live site. Production updates are gated by version tags and GitHub Releases:

1. Land the changes on main and wait for CI to pass.

2. Align package.json "version" with the release (e.g. 0.1.0), then create and push a semver tag from that commit:

   git checkout main
   git pull
   git tag v0.1.0
   git push origin v0.1.0

3. Pushing the tag runs the Draft release workflow, which opens a draft GitHub Release (with generated notes). Nothing is deployed yet.

4. Review the draft under Releases, edit notes if needed, then Publish release.

5. Publishing triggers the Deploy production workflow, which builds the tagged commit and updates docs.eld.network.

Only tags matching v*.*.* (for example v0.1.0) participate in this flow. Tags must point at a commit that is on main.

Links

• Eld website
• Block explorer
• X / Twitter
• Contributing
• Security policy

License

MIT — see LICENSE.

Font files in static/fonts/ are Ioskeley Mono, licensed under the SIL Open Font License 1.1 — see static/fonts/LICENSE.