Merge pull request #687 from vuejs/next-theme

feat: 1.0.0-alpha merge

Author: kiaking

.github/contributing.md

@@ -34,16 +34,24 @@ $ pnpm install
 
 ### Setup VitePress Dev Environment
 
-You may start VitePress local dev environment by running `pnpm run dev`.
+At first, execute the `pnpm run build` command.
 
 ```bash
-$ pnpm run dev
+$ pnpm run build
 ```
 
-The easiest way to start testing out VitePress is to tweak the VitePress docs. You may run `pnpm run docs` folder to boot up VitePress documentation site locally, with live reloading of the source code.
+You only need to do this once for your fresh project. It copies required files and makes sure everything is in place. After this, you only need to run `dev` related commands.
+
+The easiest way to start testing out VitePress is to tweak the VitePress docs. You may run `pnpm run docs` to boot up VitePress documentation site locally, with live reloading of the source code.
 
 ```bash
 $ pnpm run docs
 ```
 
 After executing the above command, visit http://localhost:3000 and try modifying the source code. You'll get live update.
+
+If you don't need docs site up and running, you may start VitePress local dev environment with `pnpm run dev`.
+
+```bash
+$ pnpm run dev
+```

.github/workflows/test.yml

@@ -13,7 +13,9 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/[email protected]
+        with:
+          version: 7.0.1
 
       - name: Set node version to ${{ matrix.node_version }}
         uses: actions/setup-node@v3
@@ -24,8 +26,11 @@ jobs:
       - name: Install deps
         run: pnpm install
 
-      - name: Build
-        run: pnpm run build
+      - name: Lint
+        run: pnpm run lint-fail
 
       - name: Test
-        run: pnpm run test
+        run: pnpm run test-run
+
+      - name: Build
+        run: pnpm run build

.gitignore

@@ -3,10 +3,10 @@
 /src/node/shared.ts
 *.log
 .DS_Store
+.idea
 .vite_opt_cache
+.vscode
 dist
 node_modules
-TODOs.md
-.vscode
-.idea
 pnpm-global
+TODOs.md

.npmrc

@@ -0,0 +1 @@
+shell-emulator=true

.prettierignore

@@ -0,0 +1,7 @@
+/docs
+/examples
+*.css
+*.md
+*.vue
+dist
+pnpm-lock.yaml

README.md

@@ -1,4 +1,4 @@
-# (WIP) VitePress 📝💨
+# VitePress (alpha) 📝💨
 
 [![Test](https://github.com/vuejs/vitepress/workflows/Test/badge.svg)](https://github.com/vuejs/vitepress/actions)
 [![npm](https://img.shields.io/npm/v/vitepress)](https://www.npmjs.com/package/vitepress)
@@ -7,6 +7,8 @@
 
 VitePress is [VuePress](https://vuepress.vuejs.org)' spiritual successor, built on top of [vite](https://github.com/vitejs/vite).
 
+Currently, it's in the `alpha` stage. It is already suitable for out-of-the-box documentation use, but the config and theming API may still change between minor releases.
+
 ## Documentation
 
 To check out docs, visit [vitepress.vuejs.org](https://vitepress.vuejs.org).

__tests__/client/theme-default/support/sideBar.spec.ts

@@ -1,28 +1,29 @@
+import { test, expect } from 'vitest'
 import { deeplyParseHeader } from 'node/utils/parseHeader'
 
 test('deeplyParseHeader', () => {
   const asserts: Record<string, string> = {
-    // Remove tail html
+    // remove tail html
     '# `H1` <Comp></Comp>': '# H1',
     '# *H1* <Comp/>': '# H1',
 
-    // Reserve code-wrapped tail html
+    // reserve code-wrapped tail html
     '# `H1` `<Comp></Comp>`': '# H1 <Comp></Comp>',
     '# *H1* `<Comp/>`': '# H1 <Comp/>',
 
-    // Remove leading html
+    // remove leading html
     '# <Comp></Comp> `H1`': '#  H1',
     '# <Comp/> *H1*': '#  H1',
 
-    // Reserve code-wrapped leading html
+    // reserve code-wrapped leading html
     '# `<Comp></Comp>` `H1`': '# <Comp></Comp> H1',
     '# `<Comp/>` *H1*': '# <Comp/> H1',
 
-    // Remove middle html
+    // remove middle html
     '# `H1` <Comp></Comp> `H2`': '# H1  H2',
     '# `H1` <Comp/> `H2`': '# H1  H2',
 
-    // Reserve middle html
+    // reserve middle html
     '# `H1` `<Comp></Comp>` `H2`': '# H1 <Comp></Comp> H2',
     '# `H1` `<Comp/>` `H2`': '# H1 <Comp/> H2'
   }

__tests__/client/theme-default/utils.spec.ts

@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import { parseHeader } from 'node/utils/parseHeader'
 
 describe('parseHeader', () => {