{"id":19680021,"url":"https://github.com/outposthq/readout","last_synced_at":"2026-05-10T05:03:30.268Z","repository":{"id":64910193,"uuid":"578449010","full_name":"outpostHQ/readout","owner":"outpostHQ","description":"Build blazing fast docs with zero configuration.","archived":false,"fork":false,"pushed_at":"2022-12-23T10:05:17.000Z","size":329,"stargazers_count":2,"open_issues_count":20,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-06T11:05:26.390Z","etag":null,"topics":["docs","documentation","documentation-generator","mdx","react","readout","theme"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outpostHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.MD","support":null},"funding":null},"created_at":"2022-12-15T04:37:58.000Z","updated_at":"2023-01-30T08:35:01.000Z","dependencies_parsed_at":"2023-01-30T18:16:41.469Z","dependency_job_id":null,"html_url":"https://github.com/outpostHQ/readout","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/outpostHQ/readout","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outpostHQ%2Freadout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outpostHQ%2Freadout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outpostHQ%2Freadout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outpostHQ%2Freadout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outpostHQ","download_url":"https://codeload.github.com/outpostHQ/readout/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outpostHQ%2Freadout/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265701114,"owners_count":23813750,"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":["docs","documentation","documentation-generator","mdx","react","readout","theme"],"created_at":"2024-11-11T18:03:34.623Z","updated_at":"2026-05-10T05:03:25.214Z","avatar_url":"https://github.com/outpostHQ.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Readout\n\nBuild blazing fast docs with zero configuration.\n\n\u003e Note: This project is under development, do not use it in production!\n\n## Instructions\n\n**Step 1:** Create a docs folder in the root of any public repository. The docs folder needs to have a file named `index.mdx` inside of it.\n\n**Step 2:** Create a `readout.config.json` file with the navigation field to generate the\nTOC of the your documentation site.\n\n## config\n\n**navigation**:\nAdd mdx file in the\n\n**sample navigation**:\\*\\*\\*\\*\n\n```json\n{\n  \"navigation\": {\n    \"anchors\": [\n      { \"name\": \"outside One\", \"href\": \"https://outpost.run\" },\n      { \"name\": \"outside two\", \"href\": \"https://controlplane.com\" }\n    ]\n  }\n}\n```\n\nYou can also have navigation groups which help you group several navigation links together\n\n```json\n{\n  \"navigation\": {\n    \"navLinks\": [\n      { \"name\": \"outside One\", \"path\": \"outside_one.mdx\" },\n      { \"name\": \"outside two\", \"path\": \"outside_two.mdx\" }\n    ],\n    \"groups\": [\n      {\n        \"name\": \"one\",\n        \"navLinks\": [\n          { \"name\": \"page One\", \"path\": \"first_post.mdx\" },\n          { \"name\": \"page two\", \"path\": \"second_post.mdx\" }\n        ]\n      },\n      {\n        \"name\": \"two\",\n        \"navLinks\": [\n          { \"name\": \"page One\", \"path\": \"first_post.mdx\" },\n          { \"name\": \"page two\", \"path\": \"second_post.mdx\" }\n        ]\n      }\n    ]\n  }\n}\n```\n\n## License\n\nReadout is a project by [Outpost](https://outpost.run).\n\nReleased under the MIT License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutposthq%2Freadout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutposthq%2Freadout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutposthq%2Freadout/lists"}