GithubHelp home page GithubHelp logo

evavic44 / adocs Goto Github PK

View Code? Open in Web Editor NEW
70.0 3.0 28.0 73 KB

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

Home Page: https://adocs.vercel.app

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

adocs's Introduction

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.

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

cd adocs

npm install

npm run docs:dev

Visit https://localhost:5173 to see your site

Build

You may run this command to build the docs

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

adocs's People

Contributors

evavic44 avatar heus-sueh avatar pavan2108 avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

adocs's Issues

Vercel Deployment Issue

I'm having this error when trying to deploy on vercel

Error: Command "npm run docs:build" exited with 126

I've overwritten
Build command: npm run docs:build
Output directory: docs/.vitepress/dist

parts as you've mentioned in your blog post.

Also I've done npm run docs:build part to create dist folder.

What am I missing?

RTL Support!

Why it does not provide an option for RTL layout?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.