# Introduction

# Built-in Commands

# Create project

vuepress-creator init project

# Create default template quickly

vuepress-creator def project

# Create AntDocs theme template quickly

vuepress-creator ads project

# Check new version

vuepress-creator upgrade

# Upgrade template

vuepress-creator upgrade -t

WARNING

When your scaffolding version is too old, updating the template may cause compatibility issues, so please go to the official to confirm the latest version of the scaffolding before doing this, then upgrade to a compatible scaffolding version.

# Get help

vuepress-creator -h

# Directory Structure

For the project generated with VuePress-Creator scaffold, the default directory structure is as follows:

project
├─ package.json
├─ .gitignore
├─ deploy.sh
├─ docs
│  ├─ .vuepress
│  │  ├─ config.js
│  │  ├─ config
│  │  │  ├─ nav.js
│  │  │  └─ sidebar.js
│  │  ├─ public
│  │  │  └─ assets
│  │  │     └─ logo.png
│  │  └─ styles
│  │     ├─ index.styl
│  │     └─ palette.styl
│  ├─ category
│  │  ├─ README.md
│  │  ├─ article-1.md
│  │  ├─ article-2.md
│  │  └─ sidebar_contents.js
│  └─ README.md

docs/.vuepress: It’s used to store global configuration, components, static resources, etc.
docs/.vuepress/config.js: Entry file of configuration, can also be yml or toml.
docs/.vuepress/config/nav.js: Used to manage the total collection of navigation menus.
docs/.vuepress/config/sidebar.js: Used to manage the total collection of sidebar directories.
docs/.vuepress/public: Static resource directory.
docs/.vuepress/styles: Stores style related files.
docs/.vuepress/styles/index.styl: Automatically applied global style files, generated at the ending of the CSS file, have a higher priority than the default style. Please refer to: index.styl
docs/.vuepress/styles/palette.styl: The palette is used to override the default color constants and to set the color constants of Stylus. Please refer to: palette-styl
docs/category: Custom directory, you can name a directory for archive management .md files.
docs/category/sidebar_contents.js: Used to manage a sub-collection of the sidebar directory. Each time you add a document, you need to write a .md file name to this file to facilitate VuePress sidebar indexing.
docs/category/README.md: Markdown documents, it's recommended to add this file to ensure normal route navigation.
docs/category/article-1.md: Markdown documents, this is usually every article you write.
docs/README.md: Basic configuration for homepage.
deploy.sh: Project deployment file, Please refer to: deploy

← Getting Started FAQ →