simpli-docsv1 v1.0.2

Simpli Docs CLI

A command-line interface tool for quickly scaffolding Simpli documentation projects.

Installation

You can use this CLI tool without installing it by using npx:

npx simpli-docsv1 my-docs-project

Or you can install it globally:

npm install -g simpli-docsv1
simpli-docsv1 my-docs-project

What it does

This CLI tool:

1. Creates a new directory with your project name
2. Clones the Simpli documentation template repository
3. Removes the Git history so you can start fresh
4. Provides next steps to get your documentation project up and running

Requirements

• Node.js 14 or higher
• Git installed on your system

Usage

npx simpli-docsv1 <project-name>

Replace <project-name> with the name of your documentation project.

After Installation

Once your project is created, follow these steps:

1. Navigate to your project directory: cd <project-name>
2. Install dependencies: npm install
3. Start the development server: npm run dev

License

MIT