GrandNewbien / docs

Documentation for the assembly, maintenance, and usage of Opulo designs.

Opulo Documentation

This repository is the source for the Opulo Documentation site found at docs.opulo.io

Local Development

Getting Started

1. Install Git if necessary: git-scm.com.

2. Open Terminal, Command Prompt, or Powershell.

3. Pick a location to store the docs, and use cd to navigate there.

4. Clone this repository:

   git clone https://github.com/opulo-inc/docs.git

5. Install Mkdocs and our plugins

   pip install -r requirements.txt

6. Open the code in your favorite code editor. We like Visual Studio Code.

Development server

In the project directory, you can run:

mkdocs serve

This runs the site in the development mode. Open http://localhost:8000 to view it in your browser.

The page will reload when you make changes.

Press CTRL+C to exit