{"id":18645857,"url":"https://github.com/interledger/docs-styleguide","last_synced_at":"2025-08-22T23:27:38.414Z","repository":{"id":196234362,"uuid":"695073466","full_name":"interledger/docs-styleguide","owner":"interledger","description":"🧑‍🏫 Style guide for our numerous docs sites. We love consistency.","archived":false,"fork":false,"pushed_at":"2024-09-17T13:55:37.000Z","size":634,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-09-17T17:21:33.896Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://interledger.net","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/interledger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-22T09:45:58.000Z","updated_at":"2024-09-17T13:55:40.000Z","dependencies_parsed_at":"2023-10-25T17:01:42.561Z","dependency_job_id":"62872062-5263-49d5-a2bb-cc72c2a48d10","html_url":"https://github.com/interledger/docs-styleguide","commit_stats":null,"previous_names":["interledger/docs-styleguide"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledger%2Fdocs-styleguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledger%2Fdocs-styleguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledger%2Fdocs-styleguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledger%2Fdocs-styleguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/interledger","download_url":"https://codeload.github.com/interledger/docs-styleguide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239449593,"owners_count":19640535,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T06:17:28.729Z","updated_at":"2025-02-18T10:16:11.377Z","avatar_url":"https://github.com/interledger.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Interledger documentation style guide\n\nThis 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.\n\n## 🚀 Project Structure\n\nInside this project, you'll see the following folders and files:\n\n```\n.\n├── public/\n├── src/\n│   ├── content/\n│   │   ├── docs/\n│   └── content.config.ts\n│   └── env.d.ts\n├── astro.config.mjs\n├── package.json\n└── tsconfig.json\n```\n\nStarlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.\n\nStatic 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:\n\n```md\n![A lovely description of your beautiful image](/img/YOUR_BEAUTIFUL_IMAGE.png)\n```\n\n## Local development\n\nWe are using [Bun](https://bun.sh/) in this repository, but you could theoretically use the package manager of your choice. To install Bun, run\n\n```sh\ncurl -fsSL https://bun.sh/install | bash\n```\n\n### 🧞 Commands\n\nAll commands are run from the root of the project, from a terminal:\n\n| Command                   | Action                                           |\n| :------------------------ | :----------------------------------------------- |\n| `bun install`             | Installs dependencies                            |\n| `bun run start`           | Starts local dev server at `localhost:1105`      |\n| `bun run build`           | Build your production site to `./dist/`          |\n| `bun run preview`         | Preview your build locally, before deploying     |\n| `bun run astro ...`       | Run CLI commands like `astro add`, `astro check` |\n| `bun run astro -- --help` | Get help using the Astro CLI                     |\n\nYou can substitute the `bun` commands with whatever package manager of your choice uses.\n\n### 👀 Want to learn more?\n\nCheck 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterledger%2Fdocs-styleguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finterledger%2Fdocs-styleguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterledger%2Fdocs-styleguide/lists"}