Skip to content

Commit 906c393

Browse files
committed
Update docs introduction
1 parent 3f99fbb commit 906c393

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

packages/docs/src/introduction.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,36 @@ As this is a scaffolding tool, you can (and should) edit the project configurati
3434

3535
Currently, the following are used for all projects:
3636

37-
- `pnpm` as package manager
38-
- TypeScript
39-
- Project uses a `packages` directory, similar to Vue Core
40-
- Vite and Vitest
41-
- Vue
37+
- [pnpm](https://pnpm.io/) as package manager
38+
- [TypeScript](https://www.typescriptlang.org/)
39+
- [Vite](https://vite.dev/)
40+
- [Vue 3](https://vuejs.org/)
41+
- [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks)
42+
- [publint](https://publint.dev/docs/)
4243

4344
Optional features include:
4445

45-
- VitePress for documentation, with optional GitHub Pages deployment
46+
- Project uses a `packages` directory, similar to [Vue core](https://github.com/vuejs/core), [Vue Router](https://github.com/vuejs/router) and [Pinia](https://github.com/vuejs/pinia)
47+
- [VitePress](https://vitepress.dev/) for documentation, with optional [GitHub Pages](https://pages.github.com/) deployment
4648
- A playground application to use for development
47-
- ESLint and ESLint Stylistic
49+
- [ESLint](https://eslint.org/), [ESLint Stylistic](https://eslint.style/) and [lint-staged](https://github.com/lint-staged/lint-staged)
50+
- [Vitest](https://vitest.dev/) for testing
4851

4952
The new project doesn't have any dependencies on special packages. It mostly uses the same dependencies as the official `create-vue` scaffolding tool, plus some widely used packages such as VitePress and ESLint Stylistic. In particular, there aren't any dependencies that tie you to the scaffolding tool.
5053

5154
Currently unsupported (you'd need to configure them yourself):
5255

5356
- JSX/TSX
5457
- Prettier
55-
- Other Vue libraries, such as Vue Router or Pinia
58+
- Other Vue libraries, such as VueUse, Vue Router and Pinia
5659
- E2E testing
60+
61+
## Prerequisites
62+
63+
Developing libraries to publish to npm is tricky. There is some inherent complexity to publishing packages that can't be avoided, and you're unlikely to succeed if you don't have prior experience of working with Vue, Vite and the wider ecosystem.
64+
65+
Both the scaffolding tool and this documentation assume that you are already comfortable working with standard Vue tooling. Previous experience of publishing packages is not required, but this documentation will only focus on aspects relevant to projects created with this scaffolding tool, it is not a general-purpose guide to building and publishing packages.
66+
67+
This scaffolding tool aims to make it easier to get started, but it doesn't completely remove the need to study the build tools you're using and learn what they can do.
68+
69+
Each library has different requirements, and you'll likely need to make changes to the project created by this tool.

0 commit comments

Comments
 (0)