docs.openever.org

Documentation for Everscale, maintained by the openever community. Built with Starlight and themed to match openever.org.

Setup

Requires Node 22.12+ (CI uses Node 24).

npm install
npm run dev         # dev server
npm run build       # type-check and build to dist/
npm run preview     # build and serve dist/
npm run fmt         # format code and config
npm run fmt:check   # check formatting

Structure

src/content/docs/        pages (Markdown and MDX)
src/components/          Starlight overrides: header links, footer, light-only theme
src/styles/theme.css     openever.org look, tokens copied from openever.org website
ec.config.mjs            code block theme
plugins/                 Markdown plugin: external links open in a new tab
public/                  static files: favicon, og.png, robots.txt, _headers

Writing docs

• Add a .md (or .mdx) file under src/content/docs/<section>/. The sidebar builds itself; order pages with sidebar: { order: 1 } in frontmatter. New sections go in sidebar in astro.config.mjs.
• Callouts: :::note, :::tip, :::caution, :::danger. Code: ```solidity for Solidity, ```sh for terminal commands.
• Links to other sites open in a new tab automatically when written as Markdown links (or <LinkCard>/<LinkButton> with a plain href). Links to openever.org stay in the same tab. Raw HTML <a> tags in .md files are not processed, so add target="_blank" rel="noopener" yourself.
• After changing plugins/, run npx astro build --force: the content cache doesn't notice plugin changes.