Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ EasyHybrid = {path = ".."}

[compat]
Documenter = "1"
DocumenterVitepress = "0.3"
DocumenterVitepress = "0.3.2"
13 changes: 7 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
{
"devDependencies": {
"@types/d3-format": "^3.0.4",
"@types/node": "^22.13.9",
"@types/markdown-it-footnote": "^3.0.4"
"@types/markdown-it-footnote": "^3.0.4",
"@types/node": "^22.13.9"
},
"scripts": {
"docs:dev": "vitepress dev build/.documenter",
"docs:build": "vitepress build build/.documenter",
"docs:preview": "vitepress preview build/.documenter"
},
"dependencies": {
"@mdit/plugin-mathjax": "^0.25.0",
"@mdit/plugin-tex": "^0.23.1",
"@nolebase/vitepress-plugin-enhanced-readabilities": "^2.18.2",
"@nolebase/vitepress-plugin-git-changelog": "^2.18.2",
"d3-format": "^3.1.0",
"markdown-it": "^14.1.0",
"markdown-it-footnote": "^4.0.0",
"vitepress": "^1.6.4",
"@mdit/plugin-mathjax": "^0.25.0",
"@mdit/plugin-tex": "^0.23.1",
"d3-format": "^3.1.0",
"vitepress-plugin-tabs": "^0.6.0"
}
}
}
13 changes: 11 additions & 2 deletions docs/src/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
NolebaseEnhancedReadabilitiesScreenMenu,
} from '@nolebase/vitepress-plugin-enhanced-readabilities/client'

import {NolebaseGitChangelogPlugin} from "@nolebase/vitepress-plugin-git-changelog/client";
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with the prevailing import style in this file, it's better to use single quotes and omit the trailing semicolon.

Suggested change
import {NolebaseGitChangelogPlugin} from "@nolebase/vitepress-plugin-git-changelog/client";
import { NolebaseGitChangelogPlugin } from '@nolebase/vitepress-plugin-git-changelog/client'


import VersionPicker from "@/VersionPicker.vue"
import StarUs from '@/StarUs.vue'
import AuthorBadge from '@/AuthorBadge.vue'
Expand All @@ -23,6 +25,7 @@ import LayoutContainer from '@/LayoutContainer.vue'
import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client'

import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css'
import "@nolebase/vitepress-plugin-git-changelog/client/style.css";
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other style imports in this file, please use single quotes and omit the trailing semicolon.

Suggested change
import "@nolebase/vitepress-plugin-git-changelog/client/style.css";
import '@nolebase/vitepress-plugin-git-changelog/client/style.css'

import './style.css'
import './docstrings.css'

Expand All @@ -45,8 +48,14 @@ export const Theme: ThemeConfig = {
enhanceApp({ app, router, siteData }) {
enhanceAppWithTabs(app);
app.component('VersionPicker', VersionPicker);
app.component('AuthorBadge', AuthorBadge)
app.component('Authors', Authors)
app.component('AuthorBadge', AuthorBadge);
app.component('Authors', Authors);
app.use(NolebaseGitChangelogPlugin, {
displayAuthorsInsideCommitLine: true,
hideChangelogHeader: true,
hideSortBy: true,
hideContributorsHeader: true
});
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The indentation for the plugin options object is inconsistent and excessive. Using a standard indentation (e.g., 2 spaces per level) would improve readability and maintainability.

Suggested change
app.use(NolebaseGitChangelogPlugin, {
displayAuthorsInsideCommitLine: true,
hideChangelogHeader: true,
hideSortBy: true,
hideContributorsHeader: true
});
app.use(NolebaseGitChangelogPlugin, {
displayAuthorsInsideCommitLine: true,
hideChangelogHeader: true,
hideSortBy: true,
hideContributorsHeader: true
});

}
}
export default Theme
Loading