Skip to content

Commit d93cc7d

Browse files
committed
docs: index
Signed-off-by: Neko Ayaka <neko@ayaka.moe>
1 parent a77cb30 commit d93cc7d

9 files changed

Lines changed: 118 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,13 @@ ni @nolebase/<integration-name> -D
8484
To find out the integration name, there is a list of integrations below.
8585

8686
- [UnoCSS (for Obsidian)](https://github.com/nolebase/obsidian-plugin-unocss)
87-
- [Auto Sidebar](./packages/vitepress-plugin-sidebar/README.md)
87+
- [Auto Sidebar (for VitePress)](./packages/vitepress-plugin-sidebar/README.md)
8888
- [Bi-Directional Links (for `markdown-it`)](./packages/markdown-it-bi-directional-links/README.md)
8989
- [Elements Transformation (for `markdown-it`)](./packages/markdown-it-element-transform/README.md)
9090
- [Lazy loading blurred thumbnails (for `markdown-it`)](./packages/markdown-it-unlazy-img/README.md)
9191
- [Enhanced Readabilities (for VitePress)](./packages/vitepress-plugin-enhanced-readabilities/README.md)
9292
- [Git-based page histories (for VitePress)](./packages/vitepress-plugin-git-changelog/README.md)
93+
- [Index page (for VitePress)](./packages/vitepress-plugin-index/README.md)
9394
- [Inline Link Previewing (for VitePress)](./packages/vitepress-plugin-inline-link-preview/README.md)
9495
- [Blinking highlight targeted heading (for VitePress)](./packages/vitepress-plugin-highlight-targeted-heading/README.md)
9596
- [Page properties (for VitePress)](./packages/vitepress-plugin-page-properties/README.md)

README.zh-CN.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,13 @@ ni @nolebase/<integration-name> -D
8383
要找到集成的名称,下面是一个我们当前支持的集成列表:
8484

8585
- [UnoCSS (Obsidian 插件)](https://github.com/nolebase/obsidian-plugin-unocss)
86-
- [自动生成侧边栏](./packages/vitepress-plugin-sidebar/README.md)
86+
- [自动生成侧边栏(VitePress 插件)](./packages/vitepress-plugin-sidebar/README.md)
8787
- [双向链接(`markdown-it` 插件)](./packages/markdown-it-bi-directional-links/README.md)
8888
- [元素转换(`markdown-it` 插件)](./packages/markdown-it-element-transform/README.md)
8989
- [懒加载模糊预览图(`markdown-it` 插件)](./packages/markdown-it-unlazy-img/README.md)
9090
- [阅读增强(VitePress 插件)](./packages/vitepress-plugin-enhanced-readabilities/README.md)
9191
- [基于 Git 的页面历史(VitePress 插件)](./packages/vitepress-plugin-git-changelog/README.md)
92+
- [索引页(VitePress 插件)](./packages/vitepress-plugin-index/README.md)
9293
- [行内链接预览(VitePress 插件)](./packages/vitepress-plugin-inline-link-preview/README.md)
9394
- [闪烁高亮当前的目标标题(VitePress 插件)](./packages/vitepress-plugin-highlight-targeted-heading/README.md)
9495
- [页面属性(VitePress 插件)](./packages/vitepress-plugin-page-properties/README.md)

docs/.vitepress/config.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
2525
text: 'Guides',
2626
items: [
2727
{ text: 'Getting Started', link: '/pages/en/guide/getting-started' },
28+
{ text: 'Recent updated pages', link: '/pages/en/recent-updates' },
2829
],
2930
},
3031
{
@@ -160,6 +161,7 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
160161
text: '集成',
161162
items: [
162163
{ text: '概览', link: '/pages/zh-CN/integrations/' },
164+
{ text: '最近更新文档', link: '/pages/zh-CN/recent-updates' },
163165
],
164166
},
165167
{

docs/pages/en/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ import biDirectionalLinksPackageJSON from '~/packages/markdown-it-bi-directional
4343
import elementTransform from '~/packages/markdown-it-element-transform/package.json'
4444
import unlazyImg from '~/packages/markdown-it-unlazy-img/package.json'
4545
import enhancedReadabilities from '~/packages/vitepress-plugin-enhanced-readabilities/package.json'
46+
import index from '~/packages/vitepress-plugin-inline-link-preview/package.json'
4647
import inlineLinkPreview from '~/packages/vitepress-plugin-inline-link-preview/package.json'
4748
import highlightTargetedHeading from '~/packages/vitepress-plugin-highlight-targeted-heading/package.json'
4849
import gitChangelog from '~/packages/vitepress-plugin-git-changelog/package.json'
@@ -87,6 +88,12 @@ Nólëbase Integrations project provides a variety of integrations, plugins, com
8788
</template>
8889
</IntegrationCard>
8990

91+
<IntegrationCard type="vitepress" title="Index page" package="vitepress-plugin-index">
92+
<template v-slot:badge>
93+
<Badge type="tip" :text="`v${index.version}`" />
94+
</template>
95+
</IntegrationCard>
96+
9097
<IntegrationCard type="vitepress" title="Inline Link Previewing" package="vitepress-plugin-inline-link-preview">
9198
<template v-slot:badge>
9299
<Badge type="tip" :text="`v${inlineLinkPreview.version}`" />

docs/pages/en/integrations/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import biDirectionalLinksPackageJSON from '~/packages/markdown-it-bi-directional
99
import elementTransform from '~/packages/markdown-it-element-transform/package.json'
1010
import unlazyImg from '~/packages/markdown-it-unlazy-img/package.json'
1111
import enhancedReadabilities from '~/packages/vitepress-plugin-enhanced-readabilities/package.json'
12+
import index from '~/packages/vitepress-plugin-index/package.json'
1213
import inlineLinkPreview from '~/packages/vitepress-plugin-inline-link-preview/package.json'
1314
import highlightTargetedHeading from '~/packages/vitepress-plugin-highlight-targeted-heading/package.json'
1415
import gitChangelog from '~/packages/vitepress-plugin-git-changelog/package.json'
@@ -64,6 +65,14 @@ Nólëbase Integrations project provides a variety of integrations, plugins, com
6465

6566
<br />
6667

68+
<IntegrationCard type="vitepress" title="Index page" package="vitepress-plugin-index">
69+
<template v-slot:badge>
70+
<Badge type="tip" :text="`v${index.version}`" />
71+
</template>
72+
</IntegrationCard>
73+
74+
<br />
75+
6776
<IntegrationCard type="vitepress" title="Inline Link Previewing" package="vitepress-plugin-inline-link-preview">
6877
<template v-slot:badge>
6978
<Badge type="tip" :text="`v${inlineLinkPreview.version}`" />
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Index page
3+
category: Index page
4+
---
5+
6+
<script setup>
7+
import packageJSON from '~/packages/vitepress-plugin-index/package.json'
8+
</script>
9+
10+
# Index page <Badge type="tip" :text="`v${packageJSON.version}`" />
11+
12+
::: warning 🚧 Constructing
13+
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.
14+
:::
15+
16+
We are still working on it, stay tuned!
17+
18+
## Installation
19+
20+
Install `@nolebase/vitepress-plugin-index` to your project dependencies by running the following command:
21+
22+
::: code-group
23+
24+
```shell [@antfu/ni]
25+
ni @nolebase/vitepress-plugin-index -D
26+
```
27+
28+
```shell [pnpm]
29+
pnpm add @nolebase/vitepress-plugin-index -D
30+
```
31+
32+
```shell [npm]
33+
npm install @nolebase/vitepress-plugin-index -D
34+
```
35+
36+
```shell [yarn]
37+
yarn add @nolebase/vitepress-plugin-index -D
38+
```
39+
40+
:::

docs/pages/zh-CN/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ import biDirectionalLinksPackageJSON from '~/packages/markdown-it-bi-directional
4343
import elementTransform from '~/packages/markdown-it-element-transform/package.json'
4444
import unlazyImg from '~/packages/markdown-it-unlazy-img/package.json'
4545
import enhancedReadabilities from '~/packages/vitepress-plugin-enhanced-readabilities/package.json'
46+
import index from '~/packages/vitepress-plugin-inline-link-preview/package.json'
4647
import inlineLinkPreview from '~/packages/vitepress-plugin-inline-link-preview/package.json'
4748
import highlightTargetedHeading from '~/packages/vitepress-plugin-highlight-targeted-heading/package.json'
4849
import gitChangelog from '~/packages/vitepress-plugin-git-changelog/package.json'
@@ -87,6 +88,12 @@ Nólëbase 集成项目提供多种不同的集成、插件、组件和库来方
8788
</template>
8889
</IntegrationCard>
8990

91+
<IntegrationCard type="vitepress" title="索引页" package="vitepress-plugin-index">
92+
<template v-slot:badge>
93+
<Badge type="tip" :text="`v${index.version}`" />
94+
</template>
95+
</IntegrationCard>
96+
9097
<IntegrationCard type="vitepress" title="行内链接预览" package="vitepress-plugin-inline-link-preview">
9198
<template v-slot:badge>
9299
<Badge type="tip" :text="`v${inlineLinkPreview.version}`" />

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import biDirectionalLinksPackageJSON from '~/packages/markdown-it-bi-directional
99
import elementTransform from '~/packages/markdown-it-element-transform/package.json'
1010
import unlazyImg from '~/packages/markdown-it-unlazy-img/package.json'
1111
import enhancedReadabilities from '~/packages/vitepress-plugin-enhanced-readabilities/package.json'
12+
import index from '~/packages/vitepress-plugin-inline-link-preview/package.json'
1213
import inlineLinkPreview from '~/packages/vitepress-plugin-inline-link-preview/package.json'
1314
import highlightTargetedHeading from '~/packages/vitepress-plugin-highlight-targeted-heading/package.json'
1415
import gitChangelog from '~/packages/vitepress-plugin-git-changelog/package.json'
@@ -64,6 +65,14 @@ Nólëbase 集成项目提供多种不同的集成、插件、组件和库来方
6465

6566
<br />
6667

68+
<IntegrationCard type="vitepress" title="索引页" package="vitepress-plugin-index">
69+
<template v-slot:badge>
70+
<Badge type="tip" :text="`v${index.version}`" />
71+
</template>
72+
</IntegrationCard>
73+
74+
<br />
75+
6776
<IntegrationCard type="vitepress" title="行内链接预览" package="vitepress-plugin-inline-link-preview">
6877
<template v-slot:badge>
6978
<Badge type="tip" :text="`v${inlineLinkPreview.version}`" />
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: 索引页
3+
category: 索引页
4+
---
5+
6+
<script setup>
7+
import packageJSON from '~/packages/vitepress-plugin-index/package.json'
8+
</script>
9+
10+
# 索引页 <Badge type="tip" :text="`v${packageJSON.version}`" />
11+
12+
::: warning 🚧 施工中
13+
很高兴见到你!但很抱歉,这个页面还在施工中,如果没有找到你感兴趣的信息,你可以先在侧边栏的导航中寻找你感兴趣的内容来开始阅读
14+
:::
15+
16+
内容施工中,敬请期待!
17+
18+
## 安装
19+
20+
通过运行以下命令将 `@nolebase/vitepress-plugin-index` 安装到您的项目依赖项中:
21+
22+
::: code-group
23+
24+
```shell [@antfu/ni]
25+
ni @nolebase/vitepress-plugin-index -D
26+
```
27+
28+
```shell [pnpm]
29+
pnpm add @nolebase/vitepress-plugin-index -D
30+
```
31+
32+
```shell [npm]
33+
npm install @nolebase/vitepress-plugin-index -D
34+
```
35+
36+
```shell [yarn]
37+
yarn add @nolebase/vitepress-plugin-index -D
38+
```
39+
40+
:::

0 commit comments

Comments
 (0)