Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vuejs/theme

VitePress theme for vuejs.org.
https://github.com/vuejs/theme

vue

Last synced: 1 day ago
JSON representation

VitePress theme for vuejs.org.

Host: GitHub
URL: https://github.com/vuejs/theme
Owner: vuejs
License: mit
Created: 2021-02-18T04:58:29.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-09-17T23:25:48.000Z (4 months ago)
Last Synced: 2024-10-29T17:06:23.938Z (3 months ago)
Topics: vue
Language: Vue
Homepage:
Size: 730 KB
Stars: 242
Watchers: 10
Forks: 85
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-vitepress-v1 - Vue Theme - Dedicated for `vuejs.org` and may defer from the default theme (:art: Themes / Official Themes)
awesome - vuejs/theme - VitePress theme for vuejs.org. (Vue)
awesome - vuejs/theme - VitePress theme for vuejs.org. (Vue)

README

# Vue Theme

This is the [VitePress](https://vitepress.vuejs.org/) theme for the official Vue documentation at `vuejs.org`.

Please note this theme is solely dedicated for `vuejs.org` and isn't meant to be used as a content-neutral theme. It does **not** follow semver and may contain hard-coded logic specific to the Vue documentation.

## Development Setup

This repo can be developed on its own since it is a self-contained VitePress theme. Make sure to use [pnpm](https://pnpm.io/) as the package manager when installing deps. A demo app is available in `/demo` and can be run with `pnpm dev`:

```bash
pnpm install
pnpm dev
```

## Developing with Real Content

To work on this theme in the context of the `vuejs.org` website requires cloning both repos and linking the theme into the docs repo:

1. Clone repositories:

```bash
git clone [email protected]:vuejs/docs.git
git clone [email protected]:vuejs/theme.git
```

2. Link theme into docs repo:

```bash
# In ./theme
pnpm install
# Make @vue/theme available for global linking
pnpm link --global

# in ./docs
pnpm install
# Link theme
pnpm link --global @vue/theme
```

3. Start VitePress server:

```bash
# in ./docs
pnpm dev
```

### Available Scripts

Here is the list of available scripts that can be used during the development.

```bash
# Boot local dev server.
$ pnpm dev

# Build demo, then serve locally. This is for testing
# production build in the local environment.
$ pnpm serve

# Run lint via Prettier.
$ pnpm lint

# Run type check via tsc.
$ pnpm type
```

## License

[MIT](http://opensource.org/licenses/MIT)