https://github.com/interledger/docs-styleguide
🧑🏫 Style guide for our numerous docs sites. We love consistency.
https://github.com/interledger/docs-styleguide
Last synced: 9 months ago
JSON representation
🧑🏫 Style guide for our numerous docs sites. We love consistency.
- Host: GitHub
- URL: https://github.com/interledger/docs-styleguide
- Owner: interledger
- Created: 2023-09-22T09:45:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T13:55:37.000Z (over 1 year ago)
- Last Synced: 2024-09-17T17:21:33.896Z (over 1 year ago)
- Language: MDX
- Homepage: https://interledger.net
- Size: 619 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Interledger documentation style guide
This is the source code for Interledger's documentation style guide, which lives at [interledger.net](https://interledger.net). It is built with [Starlight](https://starlight.astro.build/getting-started/), a documentation framework based on [Astro](https://astro.build/). It is hosted on GitHub Pages.
## 🚀 Project Structure
Inside this project, you'll see the following folders and files:
```
.
├── public/
├── src/
│ ├── content/
│ │ ├── docs/
│ └── content.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.
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:
```md
```
## Local development
We are using [Bun](https://bun.sh/) in this repository, but you could theoretically use the package manager of your choice. To install Bun, run
```sh
curl -fsSL https://bun.sh/install | bash
```
### 🧞 Commands
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:1105` |
| `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.
### 👀 Want to learn more?
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).