Penify Documentation Site

Welcome to the Penify Documentation Site, powered by VitePress. This guide will help you on how to get started with vitepress, a vue powered static site generator.

Prerequisites

• Node.js (20.x)
• Yarn
• Basic knowledge of Vue.js and Markdown

Installation

1. Clone the repository:

$ git clone https://github.com/SingularityX-ai/Penify-usage-doc-site
$ cd Penify-usage-doc-site

2. Install Yarn Packages:

$ yarn install

3. Run the development server:

$ yarn docs:dev

This will start local development server on port 3000. The site should now be running on http://localhost:3000/

Create your first page

1. Create a new Markdown file in the docs directory.

2. Add content (html or md syntax) to this markdown file.

Buidling for production

1. To build site for production, run:

yarn docs:build

The build files will be available in the .vitepress/dist directory.

2. To preview the production build, run:

yarn docs:preview

This will serve the production build locally for testing