{"_id":"@aoikarasu/remark-aoi","name":"@aoikarasu/remark-aoi","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@aoikarasu/remark-aoi","version":"0.1.0","description":"AOI extensions for remark, including underline syntax","main":"dist/index.js","module":"dist/index.esm.js","types":"dist/index.d.ts","type":"module","scripts":{"build":"rollup -c","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/aoikarasu/remark-aoi.git"},"keywords":["remark","markdown","underline","plugin"],"author":{"name":"Aoi Karasu","email":"aoikarasu@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/aoikarasu/remark-aoi/issues"},"homepage":"https://github.com/aoikarasu/remark-aoi#readme","peerDependencies":{"micromark":"^3.0.0","remark":"^14.0.0","unist-util-visit":"^4.0.0"},"devDependencies":{"@rollup/plugin-commonjs":"^22.0.0","@rollup/plugin-node-resolve":"^13.3.0","rehype-stringify":"^9.0.0","remark-parse":"^10.0.0","remark-rehype":"^10.0.0","rollup":"^2.79.1","rollup-plugin-copy":"^3.5.0"},"_id":"@aoikarasu/remark-aoi@0.1.0","_nodeVersion":"18.15.0","_npmVersion":"9.5.0","dist":{"integrity":"sha512-p0ztUE6T+iSDQ34xCLgkSR1KomMOkl75jn3COjaC57hyB2+WmppL8sKM4P205MMkWy1L5GGLZqfWEbwTXhCXdg==","shasum":"6692d4f0a0c3821d6fb7e2407023324000d4c726","tarball":"https://registry.npmjs.org/@aoikarasu/remark-aoi/-/remark-aoi-0.1.0.tgz","fileCount":8,"unpackedSize":121126,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCjtPup8EArMIuvowmeXhrsKhWZNQahXXpwIqTPprvm4AIhAM++0A2PQCBS5pjEXfjJAWJQZn4zpjKlpCRnfDfGgAcA"}]},"_npmUser":{"name":"aoikarasu","email":"aoikarasu@gmail.com"},"directories":{},"maintainers":[{"name":"aoikarasu","email":"aoikarasu@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/remark-aoi_0.1.0_1742163550208_0.8082671813417439"},"_hasShrinkwrap":false}},"time":{"created":"2025-03-16T22:19:10.145Z","0.1.0":"2025-03-16T22:19:10.394Z","modified":"2025-03-16T22:19:10.620Z"},"maintainers":[{"name":"aoikarasu","email":"aoikarasu@gmail.com"}],"description":"AOI extensions for remark, including underline syntax","homepage":"https://github.com/aoikarasu/remark-aoi#readme","keywords":["remark","markdown","underline","plugin"],"repository":{"type":"git","url":"git+https://github.com/aoikarasu/remark-aoi.git"},"author":{"name":"Aoi Karasu","email":"aoikarasu@gmail.com"},"bugs":{"url":"https://github.com/aoikarasu/remark-aoi/issues"},"license":"MIT","readme":"# @aoikarasu/remark-aoi\r\n\r\n**[remark][]** plugin to support [AOI][] arbitrarily handpicked markdown extensions (underline).\r\n\r\n[![Build][build-badge]][build]\r\n[![Coverage][coverage-badge]][coverage]\r\n[![Downloads][downloads-badge]][downloads]\r\n[![Size][size-badge]][size]\r\n\r\n## Contents\r\n\r\n* [Installation](#installation)\r\n* [Usage](#usage)\r\n* [Examples](#examples)\r\n * [Basic example](#basic-example)\r\n * [React usage example](#react-usage-example)\r\n* [Syntax](#syntax)\r\n* [AOI](#aoi)\r\n* [License](#license)\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install @aoikarasu/remark-aoi\r\n```\r\n\r\n## Usage\r\n\r\n### Basic example\r\n\r\n```jsx\r\n// …\r\n\r\nconst file = await unified()\r\n .use(remarkParse)\r\n .use(remarkAoi)\r\n .process('+one+ and ++two++')\r\n\r\nconsole.log(String(file))\r\n```\r\n\r\nYields:\r\n\r\n```html\r\n

>one and two

\r\n```\r\n\r\n### React usage example\r\n\r\n> Note: [`remark-gfm`][remark-gfm] is not required for [`@aoikarasu/remark-aoi`][remark-aoi], but the latter is a beautiful complement to the former.\r\n\r\n```jsx\r\nimport React from 'react'\r\nimport ReactMarkdown from 'react-markdown'\r\nimport remarkGfm from 'remark-gfm'\r\nimport remarkAoi from '@aoikarasu/remark-aoi'\r\n\r\nconst MarkdownRenderer = ({ content }) => (\r\n \r\n {content}\r\n \r\n)\r\n```\r\n\r\n## Syntax\r\n\r\nUse `+` characters to mark text for underlining:\r\n\r\n```markdown\r\nThis is +underlined text+.\r\n\r\nThis text is also ++underlined++.\r\n```\r\n\r\n## AOI\r\n\r\nAoi (青い) means blue in japanese. In Japanese, 青 is used to describe blue things, such as 青い空 (blue sky)、青い海 (blue ocean). Aoi (青い) can also be translated to “fresh” or “newly grown”, such as vegetation which can have a blueish green color at times. It can also be referred to as an adjective to describe someone who is “inexperienced” or “fresh to the Industry.” However, keep in mind あおい isn’t loosely interchangeable with みどり. [^1]\r\n\r\n[^1]: https://cotoacademy.com/japanese-color-blue-green-aoi-midori-%E9%9D%92%E3%81%84-%E3%81%BF%E3%81%A9%E3%82%8A/#:~:text=In%20Japanese%2C%20%E9%9D%92%20is%20used,blueish%20green%20color%20at%20times.\r\n\r\n## License\r\n\r\nRemark-Aoi: [MIT][license] © [Aoi Karasu][author],\r\noriginal code: [MIT][license] © [Titus Wormer][author-original].\r\n\r\n\r\n\r\n[aoi]: #aoi\r\n\r\n[author]: https://aoikarasu.github.io/\r\n\r\n[author-original]: https://wooorm.com\r\n\r\n[license]: license\r\n\r\n[remark]: https://github.com/remarkjs/remark\r\n\r\n[remark-aoi]: https://github.com/aoikarasu/remark-aoi\r\n\r\n[remark-gfm]: https://github.com/remarkjs/remark-gfm\r\n\r\n\r\n\r\n[build]: https://github.com/aoikarasu/remark-aoi/actions\r\n\r\n[build-badge]: https://github.com/aoikarasu/remark-aoi/workflows/main/badge.svg\r\n\r\n[coverage]: https://codecov.io/github/remarkjs/remark-gfm\r\n\r\n[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-gfm.svg\r\n\r\n[downloads]: https://www.npmjs.com/package/aoikarasu/remark-aoi\r\n\r\n[downloads-badge]: https://img.shields.io/npm/dm/remark-aoi.svg\r\n\r\n[size]: https://bundlejs.com/?q=remark-aoi\r\n\r\n[size-badge]: https://img.shields.io/bundlejs/size/remark-aoi\r\n","readmeFilename":"README.md","_rev":"1-7fe8fd315d39861c3e0b1c4e1163e23f"}