Skip to content

Commit e00b95a

Browse files
nekomeowwwnekomeowww
authored
feat(git-changelog): added i18n capabilities, added more fancy documentations (#156)
1 parent 5576235 commit e00b95a

46 files changed

Lines changed: 2802 additions & 334 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ node_modules
2020
**/.netlify/functions-serve/*
2121

2222
.npmrc
23+
24+
coverage/

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To find out the integration name, there is a list of integrations below.
5151
- [Elements Transformation (for `markdown-it`)](./packages/markdown-it-element-transform/README.md)
5252
- [Lazy loading blurred thumbnails (for `markdown-it`)](./packages/markdown-it-unlazy-img/README.md)
5353
- [Enhanced Readabilities (for VitePress)](./packages/vitepress-plugin-enhanced-readabilities/README.md)
54-
- [Changelog & File history (for VitePress)](./packages/vitepress-plugin-git-changelog/README.md)
54+
- [Git-based page histories (for VitePress)](./packages/vitepress-plugin-git-changelog/README.md)
5555
- [Inline Link Previewing (for VitePress)](./packages/vitepress-plugin-inline-link-preview/README.md)
5656
- [Blinking highlight targeted heading (for VitePress)](./packages/vitepress-plugin-highlight-targeted-heading/README.md)
5757
- [Page properties (for VitePress)](./packages/vitepress-plugin-page-properties/README.md)

‎README.zh-CN.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ ni @nolebase/<integration-name> -D
5151
- [元素转换（`markdown-it` 插件）](./packages/markdown-it-element-transform/README.md)
5252
- [懒加载模糊预览图（`markdown-it` 插件）](./packages/markdown-it-unlazy-img/README.md)
5353
- [阅读增强（VitePress 插件）](./packages/vitepress-plugin-enhanced-readabilities/README.md)
54-
- [变更记录 及 文件历史（VitePress 插件）](./packages/vitepress-plugin-git-changelog/README.md)
54+
- [基于 Git 的页面历史（VitePress 插件）](./packages/vitepress-plugin-git-changelog/README.md)
5555
- [行内链接预览（VitePress 插件）](./packages/vitepress-plugin-inline-link-preview/README.md)
5656
- [闪烁高亮当前的目标标题（VitePress 插件）](./packages/vitepress-plugin-highlight-targeted-heading/README.md)
5757
- [页面属性（VitePress 插件）](./packages/vitepress-plugin-page-properties/README.md)

‎docs/.vitepress/config.ts‎

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
3737
{ text: 'Enhanced Readabilities', link: '/pages/en/integrations/vitepress-plugin-enhanced-readabilities/' },
3838
{ text: 'Inline Links Previewing', link: '/pages/en/integrations/vitepress-plugin-inline-link-preview/' },
3939
{ text: 'Blinking highlight targeted heading', link: '/pages/en/integrations/vitepress-plugin-highlight-targeted-heading/' },
40-
{ text: 'Changelog & File history', link: '/pages/en/integrations/vitepress-plugin-git-changelog/' },
40+
{ text: 'Git-based page histories', link: '/pages/en/integrations/vitepress-plugin-git-changelog/' },
4141
{ text: 'Page properties', link: '/pages/en/integrations/vitepress-plugin-page-properties/' },
4242
{ text: 'Previewing image (social media card) generation', link: '/pages/en/integrations/vitepress-plugin-og-image/' },
4343
{ text: 'Enhanced mark elements', link: '/pages/en/integrations/vitepress-plugin-enhanced-mark/' },
@@ -96,7 +96,16 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
9696
],
9797
},
9898
{ text: 'Blinking highlight targeted heading', link: '/pages/en/integrations/vitepress-plugin-highlight-targeted-heading/' },
99-
{ text: 'Changelog & File history', link: '/pages/en/integrations/vitepress-plugin-git-changelog/' },
99+
{
100+
text: 'Git-based page histories',
101+
collapsed: true,
102+
items: [
103+
{ text: 'Overview', link: '/pages/en/integrations/vitepress-plugin-git-changelog/' },
104+
{ text: 'Getting started', link: '/pages/en/integrations/vitepress-plugin-git-changelog/getting-started' },
105+
{ text: 'Configure UI', link: '/pages/en/integrations/vitepress-plugin-git-changelog/configure-ui' },
106+
{ text: 'Configure Vite Plugins', link: '/pages/en/integrations/vitepress-plugin-git-changelog/configure-vite-plugins' },
107+
],
108+
},
100109
{ text: 'Page properties', link: '/pages/en/integrations/vitepress-plugin-page-properties/' },
101110
{ text: 'Previewing image (social media card) generation', link: '/pages/en/integrations/vitepress-plugin-og-image/' },
102111
{ text: 'Enhanced mark elements', link: '/pages/en/integrations/vitepress-plugin-enhanced-mark/' },
@@ -171,7 +180,7 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
171180
{ text: '阅读增强', link: '/pages/zh-CN/integrations/vitepress-plugin-enhanced-readabilities/' },
172181
{ text: '行内链接预览', link: '/pages/zh-CN/integrations/vitepress-plugin-inline-link-preview/' },
173182
{ text: '闪烁高亮当前的目标标题', link: '/pages/zh-CN/integrations/vitepress-plugin-highlight-targeted-heading/' },
174-
{ text: '变更日志 及 文件历史', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/' },
183+
{ text: '基于 Git 的页面历史', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/' },
175184
{ text: '页面属性', link: '/pages/zh-CN/integrations/vitepress-plugin-page-properties/' },
176185
{ text: '预览图片（社交媒体卡片）生成', link: '/pages/zh-CN/integrations/vitepress-plugin-og-image/' },
177186
{ text: 'mark 元素增强', link: '/pages/zh-CN/integrations/vitepress-plugin-enhanced-mark/' },
@@ -230,7 +239,16 @@ export const sidebars: Record<string, DefaultTheme.Sidebar> = {
230239
],
231240
},
232241
{ text: '闪烁高亮当前的目标标题', link: '/pages/zh-CN/integrations/vitepress-plugin-highlight-targeted-heading/' },
233-
{ text: '变更日志 及 文件历史', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/' },
242+
{
243+
text: '基于 Git 的页面历史',
244+
collapsed: true,
245+
items: [
246+
{ text: '介绍', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/' },
247+
{ text: '快速上手', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/getting-started' },
248+
{ text: '配置 UI 组件', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-ui' },
249+
{ text: '配置 Vite 插件', link: '/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-vite-plugins' },
250+
],
251+
},
234252
{ text: '页面属性', link: '/pages/zh-CN/integrations/vitepress-plugin-page-properties/' },
235253
{ text: '预览图片（社交媒体卡片）生成', link: '/pages/zh-CN/integrations/vitepress-plugin-og-image/' },
236254
{ text: 'mark 元素增强', link: '/pages/zh-CN/integrations/vitepress-plugin-enhanced-mark/' },
@@ -416,7 +434,7 @@ export default defineConfig({
416434
{ prefix: '/pages/en/integrations/markdown-it', text: 'Markdown It Plugins' },
417435
{ prefix: '/pages/en/integrations/obsidian-plugin', text: 'Obsidian Plugins' },
418436
{ prefix: '/pages/en/integrations/vitepress-plugin-inline-link-preview', text: 'VitePress Plugin: Inline Links Previewing' },
419-
{ prefix: '/pages/en/integrations/vitepress-plugin-git-changelog', text: 'VitePress Plugin: Changelog & File history' },
437+
{ prefix: '/pages/en/integrations/vitepress-plugin-git-changelog', text: 'VitePress Plugin: Git-based page histories' },
420438
{ prefix: '/pages/en/integrations/vitepress-plugin-thumbnail-hash', text: 'VitePress Plugin: Thumbnail hashing for images' },
421439
{ prefix: '/pages/en/integrations/vitepress-plugin', text: 'VitePress Plugins' },
422440
{ prefix: '/pages/en/integrations/', text: 'Integrations' },

‎docs/pages/en/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ Nólëbase Integrations project provides a variety of integrations, plugins, com
7373
</template>
7474
</IntegrationCard>
7575

76-
<IntegrationCard type="vitepress" title="Changelog & File history" package="vitepress-plugin-git-changelog">
76+
<IntegrationCard type="vitepress" title="Git-based page histories" package="vitepress-plugin-git-changelog">
7777
<template v-slot:badge>
78-
<Badge type="danger" text="Alpha" />
78+
<Badge type="tip" text="v1.28.0" />
7979
</template>
8080
</IntegrationCard>
8181

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ Nólëbase Integrations project provides a variety of integrations, plugins, com
5454

5555
<br />
5656

57-
<IntegrationCard type="vitepress" title="Changelog & File history" package="vitepress-plugin-git-changelog">
57+
<IntegrationCard type="vitepress" title="Git-based page histories" package="vitepress-plugin-git-changelog">
5858
<template v-slot:badge>
59-
<Badge type="danger" text="Alpha" />
59+
<Badge type="tip" text="v1.28.0" />
6060
</template>
6161
</IntegrationCard>
6262

‎docs/pages/en/integrations/markdown-it-bi-directional-links/index.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@ This plugin is a fully featured compatible implementation version of [Obsidian](
99

1010
## Features
1111

12-
<div grid="~ cols-[auto_1fr] gap-1" items-center my-1>
13-
<span i-icon-park-outline:check-one text="green-600" />
12+
<div grid="~ cols-[auto_1fr] gap-1" items-start my-1>
13+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1414
<span>Basic syntax</span>
15-
<span i-icon-park-outline:check-one text="green-600" />
15+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1616
<span>Able to handle hash tags <code>#</code></span>
17-
<span i-icon-park-outline:check-one text="green-600" />
17+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1818
<span>Able to handle query strings <code>?</code></span>
19-
<span i-icon-park-outline:check-one text="green-600" />
19+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
2020
<span>Images</span>
21-
<span i-icon-park-outline:check-one text="green-600" />
21+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
2222
<span>Custom text</span>
23-
<span i-icon-park-outline:check-one text="green-600" />
23+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
2424
<span>Custom HTML attributes</span>
25-
<span i-icon-park-outline:check-one text="green-600" />
25+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
2626
<span>Same name pages</span>
27-
<span i-icon-park-outline:check-one text="green-600" />
27+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
2828
<span>Absolute path</span>
2929
</div>
3030

‎docs/pages/en/integrations/markdown-it-bi-directional-links/syntax.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
The following syntaxes are supported:
44

5-
<div grid="~ cols-[auto_1fr] gap-1" items-center my-1>
6-
<span i-icon-park-outline:check-one text="green-600" />
5+
<div grid="~ cols-[auto_1fr] gap-1" items-start my-1>
6+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
77
<span>Basic syntax</span>
8-
<span i-icon-park-outline:check-one text="green-600" />
8+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
99
<span>Links with hash tags <code>#</code></span>
10-
<span i-icon-park-outline:check-one text="green-600" />
10+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1111
<span>Links with query strings <code>?</code></span>
12-
<span i-icon-park-outline:check-one text="green-600" />
12+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1313
<span>Images</span>
14-
<span i-icon-park-outline:check-one text="green-600" />
14+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1515
<span>Custom text</span>
16-
<span i-icon-park-outline:check-one text="green-600" />
16+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1717
<span>Custom HTML attributes</span>
18-
<span i-icon-park-outline:check-one text="green-600" />
18+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1919
<span>Same name pages</span>
20-
<span i-icon-park-outline:check-one text="green-600" />
20+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
2121
<span>Absolute path</span>
2222
</div>
2323

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ As an interesting little plugin, it adds a <mark>sliding animation</mark> to you
44

55
## Features
66

7-
<div grid="~ cols-[auto_1fr] gap-1" items-center my-1>
8-
<span i-icon-park-outline:check-one text="green-600" />
7+
<div grid="~ cols-[auto_1fr] gap-1" items-start my-1>
8+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
99
<span>No JavaScripts</span>
10-
<span i-icon-park-outline:check-one text="green-600" />
10+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1111
<span>Stunning looking <mark>animations</mark></span>
12-
<span i-icon-park-outline:check-one text="green-600" />
12+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1313
<span>Multi-line supports</span>
14-
<span i-icon-park-outline:check-one text="green-600" />
14+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1515
<span>Day / Night theme (Dark mode) supported</span>
16-
<span i-icon-park-outline:check-one text="green-600" />
16+
<div h=[1rem]><div i-icon-park-outline:check-one text="green-600" /></div>
1717
<span>Natively compatible with VitePress design</span>
1818
</div>
1919

0 commit comments

Comments
 (0)