{"id":17047223,"url":"https://github.com/ankitrgadiya/mdbook-hide","last_synced_at":"2025-04-12T15:52:15.401Z","repository":{"id":182114191,"uuid":"665165632","full_name":"ankitrgadiya/mdbook-hide","owner":"ankitrgadiya","description":"A preprocessor for mdbook that adds support for hidden chapters.","archived":false,"fork":false,"pushed_at":"2023-09-30T10:26:15.000Z","size":28,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-03T09:49:31.695Z","etag":null,"topics":["markdown","mdbook","mdbook-plugin","mdbook-preprocessor","rust"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/mdbook-hide","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ankitrgadiya.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}},"created_at":"2023-07-11T15:22:08.000Z","updated_at":"2024-10-23T05:08:04.000Z","dependencies_parsed_at":"2023-07-18T19:43:37.873Z","dependency_job_id":null,"html_url":"https://github.com/ankitrgadiya/mdbook-hide","commit_stats":null,"previous_names":["ankitrgadiya/mdbook-hide"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankitrgadiya%2Fmdbook-hide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankitrgadiya%2Fmdbook-hide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankitrgadiya%2Fmdbook-hide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankitrgadiya%2Fmdbook-hide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ankitrgadiya","download_url":"https://codeload.github.com/ankitrgadiya/mdbook-hide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248592034,"owners_count":21130163,"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":["markdown","mdbook","mdbook-plugin","mdbook-preprocessor","rust"],"created_at":"2024-10-14T09:48:52.631Z","updated_at":"2025-04-12T15:52:15.380Z","avatar_url":"https://github.com/ankitrgadiya.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mdbook-hide\n\nA preprocessor for [mdbook](https://rust-lang.github.io/mdBook) that adds\nsupport for hidden chapters. The hidden chapters can be marked by adding a\nspecial Markdown comment. Based on the config, hidden chapters can be added or\nremoved in the build.\n\n## Installation\n\nCurrently, this preprocessor is only available as a crate. In future, I'll add\nthe binary releases as well. To install, run the command:\n\n```sh\ncargo install mdbook-hide\n```\n\n## Usage\n\nTo use the preprocessor in your mdbook, add the following section in the\n`book.toml`. If the `hide` is set to true, then the hidden chapters will be\nremoved.\n\n```toml\n[preprocessor.hide]\nhide = true\n```\n\nTo mark a chapter as hidden, add this special Comment anywhere in the Markdown\nfile. It is better to have it at the top of the file for clarity.\n\n```markdown\n\u003c!--hidden--\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankitrgadiya%2Fmdbook-hide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankitrgadiya%2Fmdbook-hide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankitrgadiya%2Fmdbook-hide/lists"}