Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2heal1/rspress-plugin-annotation-words
https://github.com/2heal1/rspress-plugin-annotation-words
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/2heal1/rspress-plugin-annotation-words
- Owner: 2heal1
- License: mit
- Created: 2024-10-22T13:12:15.000Z (22 days ago)
- Default Branch: main
- Last Pushed: 2024-11-04T09:38:01.000Z (10 days ago)
- Last Synced: 2024-11-04T10:30:34.354Z (10 days ago)
- Language: TypeScript
- Size: 70.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rspack - rspress-plugin-annotation-words
README
# rspress-plugin-annotation-words
A plugin for Rsoress to support annotation words.
## Examples
[Repo](https://github.com/module-federation/core/blob/main/apps/website-new/rspress.config.ts#L75)
[Docs url](https://module-federation.io/guide/troubleshooting/runtime/RUNTIME-007.html)
## Install
```bash
# npm
npm install rspress-plugin-annotation-words
# yarn
yarn add rspress-plugin-annotation-words
# pnpm
pnpm install rspress-plugin-annotation-words
```
## Usage
```js
import { defineConfig } from 'rspress/config';
import { pluginAnnotationWords } from 'rspress-plugin-annotation-words'
import path from 'path';
export default defineConfig({
// ...
plugins:[pluginAnnotationWords({
wordsMapPath:'words-map.json'
})],
});
```
add `words-map.json` to `public` folder, the content is like this:
```json
{
"word":{
"id":"word",
"lang":{
"zh":{
"aliases":[
{"key":"word aliases"}
],
"description":"描述",
"related_meta":{
"docs":[{
"id":"word-docs",
"title":"文档标题（通常用于 rspress 内部链接）",
"url":"/zh/configure/name.html#name"
}],
"links":[{
"id":"word-link",
"title":"外部链接",
"url":"https://github.com/2heal1/rspress-plugin-annotation-words"
}]
}
},
"en":{
"aliases":[
{"key":"word aliases"}
],
"description":"word name",
"related_meta":{
"docs":[{
"id":"word-docs",
"title":"word title(usually used for rspress internal links)",
"url":"/en/configure/name.html#name"
}],
"links":[{
"id":"word-link",
"title":"external link",
"url":"https://github.com/2heal1/rspress-plugin-annotation-words"
}]
}
}
}
},
}
```
## Options
```ts
interface Options {
/**
* words map path
*/
wordsMapPath:string;
ignoreWords?: string[];
ignorePaths?: RegExp[];
}
```