Skip to content

Commit 1c4f57c

Browse files
committed
update readme
1 parent 207bed7 commit 1c4f57c

File tree

3 files changed

+9
-187
lines changed

3 files changed

+9
-187
lines changed

.github/contributing.md

Whitespace-only changes.

.github/contributing/doc-style-guide.md

Lines changed: 0 additions & 152 deletions
This file was deleted.

README.md

Lines changed: 9 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,49 +2,23 @@
22

33
This is the WIP branch of the brand new vuejs.org. **The content is under heavy updates and re-organization so please refrain from submitting PRs to this branch until we have removed this notice.**
44

5-
## Dev Setup
5+
## Contributing
66

7-
This site is built with [VitePress](https://github.com/vuejs/vitepress) and [@vue/theme](https://github.com/vuejs/vue-theme). Site content is written in Markdown format located in `src`.
7+
This site is built with [VitePress](https://github.com/vuejs/vitepress) and depends on [@vue/theme](https://github.com/vuejs/vue-theme). Site content is written in Markdown format located in `src`. For simple edits, you can directly edit the file on GitHub and generate a Pull Request.
88

9-
Make sure to use [pnpm](https://pnpm.io/) as the package manager:
9+
For local development, [pnpm](https://pnpm.io/) is preferred as package manager:
1010

11-
```sh
11+
```bash
1212
pnpm i
1313
pnpm run dev
1414
```
1515

16-
## Writing
17-
18-
See the [Vue Docs Writing Guide](https://v3.vuejs.org/guide/writing-guide.html) for our rules and recommendations on writing and maintaining documentation.
19-
20-
## Developing
21-
22-
For now, local development requires cloning both this repo and `vuejs/theme`:
23-
24-
1. Clone repositories
25-
26-
```bash
27-
git clone [email protected]:vuejs/docs.git
28-
git clone [email protected]:vuejs/theme.git
29-
```
30-
31-
2. Link theme into docs repo
16+
## Working on the content
3217

33-
```bash
34-
# In ./theme
35-
# Install dependencies
36-
pnpm i
37-
# Link workspace in ./theme
38-
pnpm link --global
18+
- See VitePress docs on supported [Markdown Extensions](https://vitepress.vuejs.org/guide/markdown.html) and the ability to [use Vue syntax inside markdown](https://vitepress.vuejs.org/guide/using-vue.html).
3919

40-
# in ./docs
41-
pnpm link --global @vue/theme
42-
```
20+
- See the [Writing Guide](https://github.com/vuejs/docs/blob/main/.github/contributing/writing-guide.md) for our rules and recommendations on writing and maintaining documentation content.
4321

44-
3. Install deps and start VitePress server
22+
## Working on the theme
4523

46-
```bash
47-
# in ./docs
48-
pnpm i
49-
pnpm run dev
50-
```
24+
If changes need to made for the theme, check out the [instructions for developing the theme alongside the docs](https://github.com/vuejs/vue-theme#developing-with-real-content).

0 commit comments

Comments
 (0)