https://github.com/vuepress/create-vuepress-site

VuePress Site Generator
https://github.com/vuepress/create-vuepress-site

docs vuepress

Last synced: 6 days ago
JSON representation

VuePress Site Generator

• Host: GitHub
• URL: https://github.com/vuepress/create-vuepress-site
• Owner: vuepress
• License: mit
• Archived: true
• Created: 2020-08-22T02:03:13.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-28T15:47:52.000Z (12 months ago)
• Last Synced: 2024-10-31T17:55:32.788Z (10 days ago)
• Topics: docs, vuepress
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/create-vuepress-site
• Size: 130 KB
• Stars: 116
• Watchers: 4
• Forks: 43
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# create-vuepress-site

Scaffolding a VuePress project

## Getting Started

### Run generator

In the desired folder, run the following command to start the VuePress site generator:

```shell

npx create-vuepress-site

# yarn create vuepress-site

```

This will create a scaffolded documentation site in the `docs` directory that is enclosed from the rest of the folder.

### Setup local environment

```shell

# Navigate into newly scaffolded docs directory

cd docs

# Install dependencies

npm install

# yarn install

# Start local dev server

npm run dev

```

By default, you should now see your scaffolded VuePress docs site at https://localhost:8080!

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Hat Tip

`create-vuepress-site` exists due to the previous work of:

- [create-vuepress](https://github.com/vuepressjs/create-vuepress)

- [create-umi](https://github.com/umijs/create-umi) (Direct reuse of scaffolding functions of the library.)