Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/evavic44/adocs

πŸ”ΈDocs template built with VitePress β€”The vite and vue powered static site generator
https://github.com/evavic44/adocs

article documentation markdown static-site-generator vite vitejs vitepress vitepress-doc vue vuejs

Last synced: about 2 months ago
JSON representation

πŸ”ΈDocs template built with VitePress β€”The vite and vue powered static site generator

Awesome Lists containing this project

README

        


adocs logo

Adocs


A docs template built using VitePress


This repository serves as a resource for the tutorial, How to Build a Modern Documentation Site with VitePress posted on freeCodeCamp


## Run project locally

Use this command below to boot this project locally.

```bash
git clone https://github.com/Evavic44/adocs.git

cd adocs

npm install

npm run docs:dev
```

Visit [https://localhost:5173](https://localhost:5173) to see your site

## Build
You may run this command to build the docs

```bash
npm run docs:build
```

## Folder Structure

```
docs/
β”œβ”€β”€ .vitepress/
β”‚ β”œβ”€β”€ config.js
β”‚ └── theme/
β”‚ β”œβ”€β”€ index.js
β”‚ └── custom.css
β”œβ”€β”€ public/
β”‚ β”œβ”€β”€ logo.svg
β”‚ └── logo-big.svg
β”œβ”€β”€ about.md
β”œβ”€β”€ configs.md
β”œβ”€β”€ contact.md
β”œβ”€β”€ get-started.md
β”œβ”€β”€ guide.md
β”œβ”€β”€ index.md
β”œβ”€β”€ package.json
└── README.md
```