# Getting started

Hardocs is a CLI to generate open hardware documentation templates and services. I is a set of commands to easily generate and maintain hardware documentation, with a standard project structure. The current version supports at the moment documentation in markdown, and a static site generator to show the hardware project in an intuitive way.

# Prerequisites

Install node.js Install git to use the gitbash

# Usage

make sure you have a .gitignore file at the root of your repository, and that it contains the following entries:

node_modules
/public/
\*.cvs#

# Generate a static website easy to maintain with markdown that can be hosted in github or gitlab

# Step 1: Install package globally

# Install the package globally
npm install hardocs -g

# Step 2: Create new documentation files within your project

# Generates docs template
docz-generate

# Step 3: Install packages and dependencies

npm install

# Step 4: Install packages and dependencies

npm link hardocs

# Step 5: Deploy locally and see your documentation on the browser

npm run start