{"id":15657828,"url":"https://github.com/lambdalisue/rs-mdbook-alerts","last_synced_at":"2025-04-09T09:09:59.761Z","repository":{"id":217158602,"uuid":"743227743","full_name":"lambdalisue/rs-mdbook-alerts","owner":"lambdalisue","description":"mdBook preprocessor to add GitHub Flavored Markdown's Alerts to your book","archived":false,"fork":false,"pushed_at":"2024-10-24T03:01:08.000Z","size":443,"stargazers_count":26,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-24T15:09:04.621Z","etag":null,"topics":["mdbook","mdbook-plugin","mdbook-plugins","mdbook-preprocessor"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/mdbook-alerts","language":"CSS","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/lambdalisue.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},"funding":{"github":"lambdalisue"}},"created_at":"2024-01-14T17:57:25.000Z","updated_at":"2024-10-24T03:00:53.000Z","dependencies_parsed_at":"2024-02-24T08:29:26.610Z","dependency_job_id":"ee0b6e48-2d0e-475b-a86a-77a59940012c","html_url":"https://github.com/lambdalisue/rs-mdbook-alerts","commit_stats":{"total_commits":81,"total_committers":2,"mean_commits":40.5,"dds":0.2716049382716049,"last_synced_commit":"656735130f79e34f873f54f0b849d6d518e27756"},"previous_names":["lambdalisue/rs-mdbook-alerts"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambdalisue%2Frs-mdbook-alerts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambdalisue%2Frs-mdbook-alerts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambdalisue%2Frs-mdbook-alerts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambdalisue%2Frs-mdbook-alerts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lambdalisue","download_url":"https://codeload.github.com/lambdalisue/rs-mdbook-alerts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248008630,"owners_count":21032556,"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":["mdbook","mdbook-plugin","mdbook-plugins","mdbook-preprocessor"],"created_at":"2024-10-03T13:09:55.335Z","updated_at":"2025-04-09T09:09:59.744Z","avatar_url":"https://github.com/lambdalisue.png","language":"CSS","funding_links":["https://github.com/sponsors/lambdalisue"],"categories":[],"sub_categories":[],"readme":"[![crates.io](https://img.shields.io/crates/v/mdbook-alerts.svg)](https://crates.io/crates/mdbook-alerts)\n[![docs.rs](https://docs.rs/mdbook-alerts/badge.svg)](https://docs.rs/mdbook-alerts)\n[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)\n[![Build](https://github.com/lambdalisue/rs-mdbook-alerts/actions/workflows/build.yml/badge.svg)](https://github.com/lambdalisue/rs-mdbook-alerts/actions/workflows/build.yml)\n[![Test](https://github.com/lambdalisue/rs-mdbook-alerts/actions/workflows/test.yml/badge.svg)](https://github.com/lambdalisue/rs-mdbook-alerts/actions/workflows/test.yml)\n[![Audit](https://github.com/lambdalisue/rs-mdbook-alerts/actions/workflows/audit.yml/badge.svg)](https://github.com/lambdalisue/rs-mdbook-alerts/actions/workflows/audit.yml)\n\n# mdbook-alerts\n\n[mdBook] preprocessor to add [GitHub Flavored Markdown's Alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) to your book like:\n\n```markdown\n\u003e [!NOTE]  \n\u003e Highlights information that users should take into account, even when skimming.\n\n\u003e [!TIP]\n\u003e Optional information to help a user be more successful.\n\n\u003e [!IMPORTANT]  \n\u003e Crucial information necessary for users to succeed.\n\n\u003e [!WARNING]  \n\u003e Critical content demanding immediate user attention due to potential risks.\n\n\u003e [!CAUTION]\n\u003e Negative potential consequences of an action.\n```\n\ninto\n\n![Rendered example](https://github.com/lambdalisue/rs-mdbook-alerts/blob/main/example/example.png?raw=true)\n\n[mdBook]: https://github.com/rust-lang/mdBook\n\n## Usage\n\nFirst, install the preprocessor:\n\n```bash\ncargo install mdbook-alerts\n```\n\nThen, add the preprocessor to your `book.toml`:\n\n```toml\n[book]\nauthors = [\"Alisue\"]\nlanguage = \"en\"\nmultilingual = false\nsrc = \"src\"\ntitle = \"mdBook Alerts preprocessor\"\n\n# ADD THIS\n[preprocessor.alerts]\n```\n\n## License\n\nThe code follows the MIT license written in [LICENSE](./LICENSE). Contributors\nneed to agree that any modifications sent to this repository follow the license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flambdalisue%2Frs-mdbook-alerts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flambdalisue%2Frs-mdbook-alerts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flambdalisue%2Frs-mdbook-alerts/lists"}