Source code for the prototype Interledger learning hub. This site is separate from the headless Drupal-powered main site and is built with Starlight, a documentation framework powered by Astro.
Inside this project, you'll see the following folders and files:
.
βββ public/
βββ src/
β βββ components/
β βββ content/
β β βββ docs/
β β βββ config.ts
β βββ layouts/
β βββ pages/
β βββ styles/
β βββ 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.
Static assets, like favicons or images, can be placed in the public/
directory. When referencing these assets in your markdown, you do not have to include public/
in the file path, so an image would have a path like:
![A lovely description of your beautiful image](/img/YOUR_BEAUTIFUL_IMAGE.png)
For more information about the way our documentation projects are set up, please refer to our documentation style guide.
We are using Bun in this repository, but you could theoretically use the package manager of your choice. To install Bun, run
curl -fsSL https://bun.sh/install | bash
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
bun install |
Installs dependencies |
bun run start |
Starts local dev server at localhost:1106 |
bun run build |
Build your production site to ./dist/ |
bun run preview |
Preview your build locally, before deploying |
bun run astro ... |
Run CLI commands like astro add , astro check |
bun run astro -- --help |
Get help using the Astro CLI |
You can substitute the bun
commands with whatever package manager of your choice uses.
Check out Starlightβs docs, read the Astro documentation, or jump into the Astro Discord server.