Skip to content

Commit 3b24077

Browse files
nekomeowwwnekomeowww
committed
docs: added docs
1 parent a83b4f5 commit 3b24077

11 files changed

Lines changed: 97 additions & 3 deletions

File tree

‎docs/.vitepress/config.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,14 @@ export default defineConfig({
4141
text: 'Markdown It Plugins',
4242
items: [
4343
{ text: 'Bi-directional links', link: '/pages/en/integrations/markdown-it-bi-directional-links/' },
44+
{ text: 'Elements Transformation', link: '/pages/en/integrations/markdown-it-element-transform/' },
4445
],
4546
},
4647
{
4748
text: 'VitePress Plugins',
4849
items: [
4950
{ text: 'Enhanced Readabilities', link: '/pages/en/integrations/vitepress-plugin-enhanced-readabilities/' },
51+
{ text: 'Inline Links Previewing', link: '/pages/en/integrations/vitepress-plugin-inline-link-preview/' },
5052
],
5153
},
5254
],
@@ -81,12 +83,14 @@ export default defineConfig({
8183
text: 'Markdown It 插件',
8284
items: [
8385
{ text: '双向链接', link: '/pages/zh-CN/integrations/markdown-it-bi-directional-links/' },
86+
{ text: '元素转换', link: '/pages/zh-CN/integrations/markdown-it-element-transform/' },
8487
],
8588
},
8689
{
8790
text: 'VitePress 插件',
8891
items: [
8992
{ text: '阅读增强', link: '/pages/zh-CN/integrations/vitepress-plugin-enhanced-readabilities/' },
93+
{ text: '行内链接预览', link: '/pages/zh-CN/integrations/vitepress-plugin-inline-link-preview/' },
9094
],
9195
},
9296
],

‎docs/pages/en/integrations/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,12 @@ Nólëbase Integrations project provides a variety of integrations, plugins, com
1010

1111
<br />
1212

13+
<IntegrationCard type="markdown-it" title="Elements Transformation" package="markdown-it-element-transform" />
14+
15+
<br />
16+
1317
<IntegrationCard type="vitepress" title="Enhanced Readabilities" package="vitepress-plugin-enhanced-readabilities" />
18+
19+
<br />
20+
21+
<IntegrationCard type="vitepress" title="Inline Link Previewing" package="vitepress-plugin-inline-link-preview" />

‎docs/pages/en/integrations/markdown-it-element-transform/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Elements Transformation
2+
3+
::: warning 🚧 Constructing
4+
Nice to meet you! But sorry, this page is still under construction. If you don’t find the information you are interested in, you can first find the content you are interested in in the navigation in the sidebar to start reading.
5+
:::

‎docs/pages/en/integrations/vitepress-plugin-enhanced-readabilities/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ The Reading Enhancements plugin currently provides configuration options related
243243

244244
Since VitePress doesn't provide more functionality for the default theme to expand the theme configuration, it is not friendly to the type checking and maintenance of the configuration if we directly modify the VitePress configuration file to provide configuration for the plugin.
245245

246-
Therefore we offer a way with [Vue's dependency injection](<https://vuejs.org/> api/composition-api-dependency-injection.html#injection) to provide options and configuration for the plugin:
246+
Therefore we offer a way with [Vue's dependency injection](https://vuejs.org/api/composition-api-dependency-injection.html#injection) to provide options and configuration for the plugin:
247247

248248
<!--@include: @/pages/en/snippets/details-colored-diff.md-->
249249

@@ -260,7 +260,7 @@ export const Theme: ThemeConfig = {
260260
// Rest of the code...
261261

262262
app.provide(InjectionKey, { // [!code ++]
263-
// 配置... // [!code ++]
263+
// Configuration... // [!code ++]
264264
} as Options) // [!code ++]
265265

266266
// Rest of the code...

‎docs/pages/en/integrations/vitepress-plugin-inline-link-preview/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Inline Links Previewing
2+
3+
::: warning 🚧 Constructing
4+
Nice to meet you! But sorry, this page is still under construction. If you don’t find the information you are interested in, you can first find the content you are interested in in the navigation in the sidebar to start reading.
5+
:::

‎docs/pages/zh-CN/integrations/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,12 @@ Nólëbase 集成项目提供多种不同的集成、插件、组件和库来方
1010

1111
<br />
1212

13+
<IntegrationCard type="markdown-it" title="元素转换" package="markdown-it-element-transform" />
14+
15+
<br />
16+
1317
<IntegrationCard type="vitepress" title="阅读增强" package="vitepress-plugin-enhanced-readabilities" />
18+
19+
<br />
20+
21+
<IntegrationCard type="vitepress" title="行内链接预览" package="vitepress-plugin-inline-link-preview" />

‎docs/pages/zh-CN/integrations/markdown-it-element-transform/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 元素转换
2+
3+
::: warning 🚧 施工中
4+
很高兴见到你！但很抱歉，这个页面还在施工中，如果没有找到你感兴趣的信息，你可以先在侧边栏的导航中寻找你感兴趣的内容来开始阅读
5+
:::

‎docs/pages/zh-CN/integrations/vitepress-plugin-inline-link-preview/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 行内链接预览
2+
3+
::: warning 🚧 施工中
4+
很高兴见到你！但很抱歉，这个页面还在施工中，如果没有找到你感兴趣的信息，你可以先在侧边栏的导航中寻找你感兴趣的内容来开始阅读
5+
:::

‎packages/markdown-it-bi-directional-links/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# `@nolebase/markdown-it-bi-directional-links`
2+
3+
A [`markdown-it`](https://github.com/markdown-it/markdown-it) plugin that adds Obsidian compatible internal links (bi-directional links) to your markdown.
4+
5+
## Install
6+
7+
### Npm
8+
9+
```shell
10+
npm i @nolebase/markdown-it-bi-directional-links
11+
```
12+
13+
### Yarn
14+
15+
```shell
16+
yarn add @nolebase/markdown-it-bi-directional-links
17+
```
18+
19+
### Pnpm
20+
21+
```shell
22+
pnpm add @nolebase/markdown-it-bi-directional-links
23+
```
24+
25+
## Documentation
26+
27+
Please refer to [Bi-directional Links](https://nolebase-integrations.ayaka.io/pages/en/integrations/markdown-it-bi-directional-links/) for more information.

‎packages/markdown-it-element-transform/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# `@nolebase/markdown-it-element-transform`
2+
3+
A [`markdown-it`](https://github.com/markdown-it/markdown-it) plugin that transforms elements.
4+
5+
## Install
6+
7+
### Npm
8+
9+
```shell
10+
npm i @nolebase/markdown-it-element-transform
11+
```
12+
13+
### Yarn
14+
15+
```shell
16+
yarn add @nolebase/markdown-it-element-transform
17+
```
18+
19+
### Pnpm
20+
21+
```shell
22+
pnpm add @nolebase/markdown-it-element-transform
23+
```
24+
25+
## Documentation
26+
27+
Please refer to [Element Transform](https://nolebase-integrations.ayaka.io/pages/en/integrations/markdown-it-element-transform/) for more information.

0 commit comments

Comments
 (0)