Skip to content

AndrewR3K/vitepress-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vitepress Boilerplate

An awesome boilerplate for a simple vitepress site

How to setup

  1. Clone this repo
  2. Install Node/NPM Guide
  3. Open your terminal
  4. Navigate to the project director.
  5. Run npm install
  6. Run npm run docs:dev
  7. You should now be able to see a local version of the site running on localhost

File Structure

docs -> vitepress (App settings)

docs -> api (API Doc folder) -> API Doc Pages.md

docs -> public (Public images)

docs -> api.md (root api page)

docs -> guide.md (setup guide)

docs -> index.md (Home page)

docs -> team.md (Team page)