From 433cb7b1b98638a07d66996cdd6c1fbdce8dc5eb Mon Sep 17 00:00:00 2001 From: Kia King Ishii Date: Sat, 28 May 2022 00:01:19 +0900 Subject: [PATCH] docs: make readme alpha ready --- README.md | 4 +++- docs/guide/getting-started.md | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 089440fc..4d8cbbbf 100644 --- a/README.md +++ b/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). diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index cf034bdc..2af5ddd0 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -2,6 +2,10 @@ This section will help you build a basic VitePress documentation site from ground up. If you already have an existing project and would like to keep documentation inside the project, start from Step 3. +::: warning +VitePress is currently in `alpha` status. It is already suitable for out-of-the-box documentation use, but the config and theming API may still change between minor releases. +::: + ## Step. 1 Create and change into a new directory.