{"id":44917670,"url":"https://github.com/txpipe/docs","last_synced_at":"2026-02-18T02:36:24.230Z","repository":{"id":280854424,"uuid":"940046815","full_name":"txpipe/docs","owner":"txpipe","description":"One doc site to rule them all","archived":false,"fork":false,"pushed_at":"2025-10-16T18:15:59.000Z","size":750,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-10-17T20:57:10.434Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Astro","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/txpipe.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-27T14:28:05.000Z","updated_at":"2025-10-16T18:16:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"0675945e-fec2-4a20-9871-8f5d37c3e61e","html_url":"https://github.com/txpipe/docs","commit_stats":null,"previous_names":["txpipe/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/txpipe/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txpipe%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txpipe%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txpipe%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txpipe%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/txpipe","download_url":"https://codeload.github.com/txpipe/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txpipe%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29566410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T00:47:08.760Z","status":"online","status_checked_at":"2026-02-18T02:00:09.468Z","response_time":162,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2026-02-18T02:36:24.153Z","updated_at":"2026-02-18T02:36:24.219Z","avatar_url":"https://github.com/txpipe.png","language":"Astro","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Starlight Starter Kit: Basics\n\n[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)\n\n```\nnpm create astro@latest -- --template starlight\n```\n\n[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)\n[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight\u0026create_from_path=examples/basics)\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics\u0026project-name=my-starlight-docs\u0026repository-name=my-starlight-docs)\n\n\u003e 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!\n\n## 🚀 Project Structure\n\nInside of your Astro + Starlight project, you'll see the following folders and files:\n\n```\n.\n├── public/\n├── src/\n│   ├── assets/\n│   ├── content/\n│   │   ├── docs/\n│   └── content.config.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\nImages can be added to `src/assets/` and embedded in Markdown with a relative link.\n\nStatic assets, like favicons, can be placed in the `public/` directory.\n\n## 🧞 Commands\n\nAll commands are run from the root of the project, from a terminal:\n\n| Command                   | Action                                           |\n| :------------------------ | :----------------------------------------------- |\n| `npm install`             | Installs dependencies                            |\n| `npm run dev`             | Starts local dev server at `localhost:4321`      |\n| `npm run build`           | Build your production site to `./dist/`          |\n| `npm run preview`         | Preview your build locally, before deploying     |\n| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |\n| `npm run astro -- --help` | Get help using the Astro CLI                     |\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\n## Submodules\nAfter cloning this repository, you need to initialize the submodules by running the following command:\n```sh\ngit submodule update --init --recursive\n```\n\nTo update the submodules to the latest commit, run the following command:\n```sh\ngit submodule update --recursive --remote\n```\n---\n\n## Add docs\n### Prepare the docs repository\nThe structure for the docs repository should be something like this:\n```\ndocs/\n├── content\n│   ├── quickstart.mdx\n│   ├── Installation/\n│   │   └── from_source.mdx\n│   └── ...\n├── assets (optional)\n│   ├── asset.png\n│   └── asset2.png\n...\n```\n- **content**: will contain all the documetation files. Folder name is case sensitive as it will be used as name for the sidebar.\n- **assets**: will contain all the assets used in the documentation. This folder is optional, if you don't have any assets, you can skip it.\n\n### Add the docs to the project\nFirst of all, you need to add as submodule the docs repository.\nTo add a new submodule, run the following command:\n```sh\ngit submodule add \u003csubmodule_https_repository\u003e submodules/\u003cname\u003e\n```\n\nNow, you need to create a symlink to the docs repository in the `src/content/docs` directory to the submodule.\n```sh\ncd src/content/docs\nln -s ../../../submodules/\u003csubmodule\u003e/docs/content \u003cpath_docs\u003e\n```\n\nFollowing the example, we will create a symlink to the `balius` documentation:\n```sh\ncd src/content/docs\nln -s ../../../submodules/balius/docs/content/ balius\n```\n\n### Add the assets to the project\nIf you have assets, you need to create a symlink to the assets repository in the `public/assets` directory to the submodule.\n```sh\ncd public/assets\nln -s ../../submodules/\u003csubmodule\u003e/docs/assets \u003cpath_assets\u003e\n```\n\n### Add docs to the sidebar\nFor this, we will modify `astro.config.mjs` file and add the new docs to the sidebar config.\n```ts\n{\n  label: '\u003cdocs-name\u003e',\n  autogenerate: { directory: '/\u003cdocs-folder\u003e/', collapsed: true },\n},\n```\n- **label**: how this will appear on the dropdown menu on sidebar\n- **autogenerate**: the folder that will be used to generate the sidebar. This directory is relative to the `src/content/docs` directory\n\n### Add metadata to the docs\nYou can modify the label and other properties for a folder on the sidebar by using a _meta.yml file on the folder.\nFor more information, check the [Starlight auto sidebar](https://starlight-auto-sidebar.netlify.app/) plugin.\n\n---\n\n### Example adding `balius` documentation:\n```sh\ngit submodule add -b feat/global-docs https://github.com/txpipe/balius submodules/balius\n```\n\nIn this case, we are adding the `balius` documentation as a submodule in the `submodules/balius` directory taking the information from `feat/global-docs` branch.\n\nNext, we will create the symlink to the `balius` documentation:\n```sh\ncd src/content/docs\nln -s ../../../submodules/balius/docs/content/ balius\n```\nWe don't have assets folder, so we can skip this step.\n\nFinally, we will modify the `astro.config.mjs` file to add the new docs to the sidebar:\n```ts\n{\n  label: 'Balius',\n  autogenerate: { directory: '/balius/', collapsed: true },\n},\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftxpipe%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftxpipe%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftxpipe%2Fdocs/lists"}