docs: add best-practice

This commit is contained in:
YunYouJun 2023-09-03 23:34:44 +08:00
parent 12839832ee
commit 26bc1085cd
11 changed files with 865 additions and 925 deletions

View File

@ -21,7 +21,7 @@
"devDependencies": {
"nodemon": "^3.0.1",
"vite": "^4.4.9",
"vitepress": "1.0.0-rc.4",
"vitepress": "1.0.0-rc.10",
"vue": "^3.3.4"
}
}

View File

@ -0,0 +1,15 @@
---
title: Best Practice
title_zh-CN: 最佳实践
categories:
- Guide
top: 1
---
以下是我们推荐的部分最佳实践,但您不必完全遵守。
## 文章
- 使用英文命名文件夹与文件,如 `/posts/your-post.md`
- 如需使用本地图片(且仅在对应文章中展示),您可以新建文件夹 `/posts/your-post/`,并将图片放置其中,如 `/posts/your-post/your-image.png`
- <https://github.com/YunYouJun/valaxy/issues/259>

View File

@ -45,19 +45,19 @@
"prepare": "husky install"
},
"devDependencies": {
"@antfu/eslint-config": "^0.40.2",
"@antfu/eslint-config": "^0.41.0",
"@microsoft/api-extractor": "^7.36.4",
"@types/debug": "^4.1.8",
"@types/markdown-it-attrs": "^4.1.0",
"@types/markdown-it-container": "^2.0.6",
"@types/markdown-it-emoji": "^2.0.2",
"@types/node": "^20.5.1",
"@types/node": "^20.5.9",
"@types/prompts": "^2.4.4",
"@types/resolve": "^1.20.2",
"@types/semver": "^7.5.0",
"@types/semver": "^7.5.1",
"cross-env": "^7.0.3",
"cypress": "^12.17.4",
"eslint": "^8.47.0",
"cypress": "^13.1.0",
"eslint": "^8.48.0",
"eslint-plugin-cypress": "^2.14.0",
"https-localhost": "^4.7.1",
"husky": "^8.0.3",
@ -65,8 +65,8 @@
"prompts": "^2.4.2",
"rimraf": "^5.0.1",
"tsup": "^7.2.0",
"tsx": "^3.12.7",
"typescript": "^5.1.6",
"tsx": "^3.12.8",
"typescript": "^5.2.2",
"valaxy": "workspace:*",
"valaxy-addon-algolia": "workspace:*",
"valaxy-addon-components": "workspace:*",
@ -75,7 +75,7 @@
"valaxy-addon-waline": "workspace:*",
"valaxy-theme-press": "workspace:*",
"valaxy-theme-yun": "workspace:*",
"vitest": "^0.34.2",
"vitest": "^0.34.3",
"vue-tsc": "1.8.8",
"zx": "^7.2.3"
},

View File

View File

@ -17,6 +17,6 @@
"valaxy": "latest"
},
"dependencies": {
"@waline/client": "^2.15.6"
"@waline/client": "^2.15.7"
}
}

View File

@ -18,8 +18,8 @@
"types": "types/index.d.ts",
"dependencies": {
"@explosions/fireworks": "^0.0.2",
"@iconify-json/ant-design": "^1.1.8",
"@iconify-json/simple-icons": "^1.1.67",
"@iconify-json/ant-design": "^1.1.10",
"@iconify-json/simple-icons": "^1.1.68",
"animejs": "^3.2.1"
},
"devDependencies": {

View File

@ -37,7 +37,7 @@ const licenseHtml = computed(() => {
<strong>
{{ t('post.copyright.link') + t('symbol.colon') }}
</strong>
<a :href="url">
<a :href="url" target="_blank" :title="t('post.copyright.link')">
{{ url }}
</a>
</li>

View File

@ -62,7 +62,7 @@ export function createPagesPlugin(options: ResolvedValaxyOptions) {
route.meta.frontmatter = defaultFrontmatter
}
// encode for chinese filename
// encode for chinese filename dev and build same
route.path = encodeURI(route.path)
// add default layout for home, can be overrode

View File

@ -60,15 +60,15 @@
},
"dependencies": {
"@antfu/utils": "^0.7.6",
"@ctrl/tinycolor": "^3.6.0",
"@iconify-json/carbon": "^1.1.20",
"@ctrl/tinycolor": "^4.0.2",
"@iconify-json/carbon": "^1.1.21",
"@iconify-json/ri": "^1.1.12",
"@intlify/unplugin-vue-i18n": "^0.12.3",
"@intlify/unplugin-vue-i18n": "^0.13.0",
"@types/body-scroll-lock": "^3.1.0",
"@vitejs/plugin-vue": "^4.3.3",
"@vueuse/core": "^10.3.0",
"@vitejs/plugin-vue": "^4.3.4",
"@vueuse/core": "^10.4.1",
"@vueuse/head": "^1.3.1",
"@vueuse/integrations": "^10.3.0",
"@vueuse/integrations": "^10.4.1",
"@vueuse/schema-org": "^2.2.0",
"body-scroll-lock": "4.0.0-beta.0",
"consola": "^3.2.3",
@ -101,11 +101,11 @@
"pascal-case": "^3.1.2",
"pinia": "^2.1.6",
"sass": "^1.66.1",
"shiki": "^0.14.3",
"shiki": "^0.14.4",
"star-markdown-css": "^0.4.2",
"unconfig": "^0.3.10",
"unocss": "^0.55.2",
"unplugin-vue-components": "^0.25.1",
"unocss": "^0.55.6",
"unplugin-vue-components": "^0.25.2",
"vite": "^4.4.9",
"vite-plugin-pages": "^0.31.0",
"vite-plugin-vue-layouts": "^0.8.0",
@ -117,18 +117,18 @@
"yargs": "^17.7.2"
},
"devDependencies": {
"@mdit-vue/plugin-component": "^0.12.0",
"@mdit-vue/plugin-frontmatter": "^0.12.0",
"@mdit-vue/plugin-headers": "^0.12.0",
"@mdit-vue/plugin-sfc": "^0.12.0",
"@mdit-vue/plugin-title": "^0.12.0",
"@mdit-vue/plugin-toc": "^0.12.0",
"@mdit-vue/shared": "^0.12.0",
"@mdit-vue/plugin-component": "^0.12.1",
"@mdit-vue/plugin-frontmatter": "^0.12.1",
"@mdit-vue/plugin-headers": "^0.12.1",
"@mdit-vue/plugin-sfc": "^0.12.1",
"@mdit-vue/plugin-title": "^0.12.1",
"@mdit-vue/plugin-toc": "^0.12.1",
"@mdit-vue/shared": "^0.12.1",
"@types/cross-spawn": "^6.0.2",
"@types/ejs": "^3.1.2",
"@types/html-to-text": "^9.0.1",
"@types/katex": "^0.16.2",
"@types/markdown-it": "^13.0.0",
"@types/markdown-it": "^13.0.1",
"@types/nprogress": "^0.2.0",
"@types/yargs": "^17.0.24",
"debug": "^4.3.4",

File diff suppressed because it is too large Load Diff