wip: migrate docs to vitepress

This commit is contained in:
YunYouJun 2023-07-16 19:06:53 +08:00
parent d8e0856694
commit 2b3d2a34bf
5 changed files with 74 additions and 19 deletions

View File

@ -7,8 +7,53 @@ export default defineConfig({
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' },
{
text: 'Docs',
items: [
{
text: 'Getting Started',
link: '/guide/getting-started',
},
{
text: 'Migration from Other',
link: '/migration/',
},
],
},
{
text: 'Themes',
items: [
{
text: 'Use Theme',
link: '/themes/use',
},
{
text: 'Write A Theme',
link: '/themes/write',
},
{
text: 'Themes Gallery',
link: '/themes/gallery',
},
],
},
{
text: 'Addons',
items: [
{
text: 'Why need addons?',
link: '/addons',
},
{
text: 'Use A Addon',
link: '/addons/use',
},
{
text: 'Write A Addon',
link: '/addons/write',
},
],
},
],
sidebar: [

View File

@ -41,14 +41,14 @@
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(
120deg,
#bd34fe 30%,
#41d1ff
rgb(108, 34, 236) 30%,
rgb(59, 130, 246)
);
--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#bd34fe 50%,
#47caff 50%
rgba(108, 34, 236, 0.4) 50%,
rgba(59, 130, 246, 0.4) 50%
);
--vp-home-hero-image-filter: blur(40px);
}

View File

@ -3,23 +3,32 @@
layout: home
hero:
name: "Valaxy Docs"
text: "Docs for Valaxy"
tagline: My great project tagline
name: Valaxy
text: Next Generation Static Blog Framework
tagline: Quick startup with comfortable custom experience.
image:
src: /valaxy-logo.png
alt: Valaxy Logo
actions:
- theme: brand
text: Markdown Examples
link: /markdown-examples
text: Get Started
link: /guide
- theme: alt
text: API Examples
link: /api-examples
text: Why Valaxy?
link: /guide/why
- theme: alt
text: View on GitHub
link: https://github.com/YunYouJun/valaxy
# todo, rewrite with valaxy
features:
- title: Feature A
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature B
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: "Vite: The DX that can't be beat"
details: Feel the speed of Vite. Instant server start and lightning fast HMR that stays fast regardless of the app size.
- title: Designed to be simplicity first
details: With Markdown-centered content, it's built to help you focus on writing and deployed with minimum configuration.
- title: Power of Vue meets Markdown
details: Enhance your content with all the features of Vue in Markdown, while being able to customize your site with Vue.
- title: Fully static yet still dynamic
details: Go wild with true SSG + SPA architecture. Static on page load, but engage users with 100% interactivity from there.
---

BIN
docs/public/valaxy-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -32,6 +32,7 @@
"dev:lib": "pnpm -C packages/valaxy run dev",
"dev": "pnpm -r --filter=./packages/** --parallel run dev",
"docs": "pnpm -C docs run dev",
"docs:dev": "pnpm -C docs run docs:dev",
"lint": "eslint .",
"prepublishOnly": "npm run build",
"release": "tsx scripts/release.ts",