{"id":16326185,"url":"https://github.com/nebrelbug/react-admonitions","last_synced_at":"2025-03-22T21:33:06.443Z","repository":{"id":65472882,"uuid":"205074261","full_name":"nebrelbug/react-admonitions","owner":"nebrelbug","description":"An admonitions React component, ported from remarkable-admonitions. Perfect for Docusaurus v2 and other React-based doc generators","archived":false,"fork":false,"pushed_at":"2020-09-15T22:11:32.000Z","size":2046,"stargazers_count":11,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T12:59:20.681Z","etag":null,"topics":["admonitions","alert","hints","react-component"],"latest_commit_sha":null,"homepage":"https://nebrelbug.github.io/react-admonitions/","language":"JavaScript","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/nebrelbug.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}},"created_at":"2019-08-29T03:38:52.000Z","updated_at":"2023-12-12T11:12:20.000Z","dependencies_parsed_at":"2023-01-25T11:16:00.988Z","dependency_job_id":null,"html_url":"https://github.com/nebrelbug/react-admonitions","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebrelbug%2Freact-admonitions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebrelbug%2Freact-admonitions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebrelbug%2Freact-admonitions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebrelbug%2Freact-admonitions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nebrelbug","download_url":"https://codeload.github.com/nebrelbug/react-admonitions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245023682,"owners_count":20548762,"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":["admonitions","alert","hints","react-component"],"created_at":"2024-10-10T23:07:40.819Z","updated_at":"2025-03-22T21:33:06.091Z","avatar_url":"https://github.com/nebrelbug.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-admonitions\n\n\u003e An admonitions React component, ported from remarkable-admonitions. Perfect for Docusaurus v2 and other React-based doc generators.\n\n[![NPM](https://img.shields.io/npm/v/react-admonitions.svg)](https://www.npmjs.com/package/react-admonitions) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![Build Status](https://travis-ci.com/nebrelbug/react-admonitions.svg?branch=master)](https://travis-ci.com/nebrelbug/react-admonitions)\n\n**TL;DR**\nNice-looking hints, warnings, etc. specifically targeted toward Docusaurus docs websites.\n\nTest the component out [on Stackblitz](https://stackblitz.com/edit/react-admonitions), or view the [demo](https://nebrelbug.github.io/react-admonitions/)\n\n## Install\n\n```bash\nnpm install --save react-admonitions\n```\n\n## Screenshots\n\n![Example Pictures](assets/preview.png)\n\n## Usage\n\n```jsx\nimport React, { Component } from 'react'\n\nimport Admonition from 'react-admonitions'\n\nclass Example extends Component {\n  render() {\n    return (\n      \u003cAdmonition type=\"warning\" title=\"Do not do this\"\u003e\n        Admonition Content\n      \u003c/Admonition\u003e\n    )\n  }\n}\n```\n\n## Props\n\n| Name           | Default | Description                                                                                                            |\n| -------------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |\n| **`type`**     | none    | What type of admonition you want to display. Valid options: `\"warning\"`, `\"tip\"`, `\"caution\"`, `\"note\"`, `\"important\"`, `\"question\"` |\n| **`iconType`** | `\"svg\"` | The type of admonition icon. Valid options: `\"svg\"`, `\"emoji\"` |\n| **`title`**    | none | The, well, title of the admonition |\n\n## Credits\n\nHTML, styles, and concept all come from the amazing Markdown plugin by [@favoloso](https://github.com/favoloso), [remarkable-admonitions](https://github.com/favoloso/remarkable-admonitions).\n\n## License\n\nMIT © [nebrelbug](https://github.com/nebrelbug)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebrelbug%2Freact-admonitions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnebrelbug%2Freact-admonitions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebrelbug%2Freact-admonitions/lists"}