Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/show-docs/remark-docusaurus
Remark plugin for docusaurus features.
https://github.com/show-docs/remark-docusaurus
docusaurus markdown remark
Last synced: 3 months ago
JSON representation
Remark plugin for docusaurus features.
- Host: GitHub
- URL: https://github.com/show-docs/remark-docusaurus
- Owner: show-docs
- License: mit
- Created: 2022-08-11T01:51:48.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-08T08:18:39.000Z (about 1 year ago)
- Last Synced: 2024-10-31T08:26:21.121Z (3 months ago)
- Topics: docusaurus, markdown, remark
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/remark-docusaurus
- Size: 1000 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - show-docs/remark-docusaurus - Remark plugin for docusaurus features. (JavaScript)
README
# remark-docusaurus
Remark plugin for docusaurus features.
[![npm][npm-badge]][npm-url]
[![github][github-badge]][github-url]
![node][node-badge]
[npm-url]: https://www.npmjs.com/package/remark-docusaurus
[npm-badge]: https://img.shields.io/npm/v/remark-docusaurus.svg?style=flat-square&logo=npm
[github-url]: https://github.com/nice-move/remark-docusaurus
[github-badge]: https://img.shields.io/npm/l/remark-docusaurus.svg?style=flat-square&colorB=blue&logo=github
[node-badge]: https://img.shields.io/node/v/remark-docusaurus.svg?style=flat-square&colorB=green&logo=node.js
## Installation
```bash
npm install remark-docusaurus --save-dev
```
## Usage
```mjs
// docusaurus.config.mjs
import {
autoTabs,
docCardList,
draftSAdmonition,
svgToObject
} from 'remark-docusaurus';
export default {
presets: [
[
'classic',
{
docs: {
beforeDefaultRemarkPlugins: [
autoTabs,
docCardList,
draftSAdmonition,
svgToObject
]
}
}
]
]
};
```
### DocCardList
Turn:
```markdown
# heading
:docusaurus-doc-card-list
foo bar
```
Into:
```markdown
import DocCardList from '@theme/DocCardList';
# heading
foo bar
```
### AutoTabs
#### Options.labels
- type: `object`
- default: {}
- description: Will merge with default presets
Turn:
````markdown
```js tab
```
````
Into:
````md
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
```js tab
```
````
## Tips
This plugin only compatible with `docusaurus@3/remark@^13+/mdx@3+`.
## Related
- [markdown-code-block-meta](https://github.com/nice-move/markdown-code-block-meta)
- [rehype-extended-table](https://github.com/nice-move/rehype-extended-table)
- [remark-code-example](https://github.com/nice-move/remark-code-example)
- [remark-kroki](https://github.com/nice-move/remark-kroki)