{"id":19899501,"url":"https://github.com/brightercommand/docs","last_synced_at":"2025-05-02T22:31:58.791Z","repository":{"id":16540277,"uuid":"80140835","full_name":"BrighterCommand/Docs","owner":"BrighterCommand","description":"Documentation for Paramore projects","archived":false,"fork":false,"pushed_at":"2025-03-18T19:58:52.000Z","size":26362,"stargazers_count":8,"open_issues_count":3,"forks_count":23,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-07T07:51:16.825Z","etag":null,"topics":["brighter","paramore"],"latest_commit_sha":null,"homepage":"https://brightercommand.gitbook.io/paramore-brighter-documentation/","language":"Shell","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/BrighterCommand.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2017-01-26T18:10:16.000Z","updated_at":"2025-03-18T19:58:57.000Z","dependencies_parsed_at":"2023-11-09T11:18:46.262Z","dependency_job_id":"e12fa3da-32ee-46f1-9e5f-440d2faca522","html_url":"https://github.com/BrighterCommand/Docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrighterCommand%2FDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrighterCommand%2FDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrighterCommand%2FDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrighterCommand%2FDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BrighterCommand","download_url":"https://codeload.github.com/BrighterCommand/Docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252116408,"owners_count":21697374,"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":["brighter","paramore"],"created_at":"2024-11-12T20:08:54.589Z","updated_at":"2025-05-02T22:31:53.783Z","avatar_url":"https://github.com/BrighterCommand.png","language":"Shell","readme":"# Brighter and Darker Documentation\n\nDocumentation for the [Brighter](https://github.com/BrighterCommand/Brighter) and [Darker](https://github.com/BrighterCommand/Darker) projects.\n\n## GitHub\nThe documentation can be used as is, by cloning this [repository](https://github.com/BrighterCommand/Docs) and viewing the markdown files.\n\n### GitHub Organization\n\nThe markdown files in the source are organized by version. We support two versions at any time.\n\n\u003cstrong\u003e\\source\u003c/strong\u003e\n* shared: Markdown files that work with all versions\n* N: Markdown files that are specific to a version\n\n\u003cstrong\u003e\\contents\u003c/strong\u003e\n* N: Markdown file for a version (merges \\source\\shared \u0026\u0026 \\source\\N)\n\n### Building the Documentation\n\nWe use the [Rewind](https://github.com/BrighterCommand/Rewind) tool to build \u003cstrong\u003e\\contents\u003c/strong\u003e from  \u003cstrong\u003e\\source\u003c/strong\u003e. See the [README](https://github.com/BrighterCommand/Rewind/blob/main/README.md) for more information on how to build the documentation, in particular how the \u003cstrong\u003e.toc.yaml\u003c/strong\u003e file works.\n\nTypically, you can build the documentation by running the following command at the root:\n\n```bash\nbin/Rewind makebook source .\n```\n\n## GitBook\n### Sources\nFor convenience the documentation is made available via [GitBook](https://brightercommand.gitbook.io/paramore-brighter-documentation/).\n\nGitBook uses the pages from \u003cstrong\u003e\\contents\u003c/strong\u003e\n\n### Structure\n\n\u003cstrong\u003eVERSION N\u003c/strong\u003e\n* Version Info\n\n\u003cstrong\u003ePage Group\u003c/strong\u003e\n* Documentation File\n* Documentation File\n\n... More Groups\n\n\u003cstrong\u003eEND OF VERSION N\u003c/strong\u003e\n* Version Info\n\n### How to Use\n\nIn the table of contents, the first page group for the documents belonging to a version will be \"VERSION N\" where N is the version number. That page group has one entry only, a version header. This holds metadata about the version.\n\nPage groups that follow are documentation specific to that version. \n\nThe page groups for that version are terminated by a page group \"END OF VERSION N\" where N is the version number. That page group has one entry only, a version footer. This holds metadata about the version. \n\nAlways ensure that you are in the correct part of the documentation for the version that you are working with.\n\n### GitBook Limitations\nGitBook's table of contents is a series of page groups grouped by header (level is ignored). There are limitations to how we can organize this. For this reason the best we can do is to \"bracket\" a version with version page groups.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrightercommand%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrightercommand%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrightercommand%2Fdocs/lists"}