Getting Started

This guide explains how to use utopia-project to add documentation to your project.

Installation

Add the gem to your project:

$ bundle add utopia-project

Usage

Start Local Server

Start the local server to preview documentation:

$ bake utopia:project:serve

Right now, this server does not reload the code index, so you will need to restart the server to update the code index. This will be fixed in the future.

Generate Static Site

You can generate a static copy of your documentation into the docs/ folder:

$ bake utopia:project:static

You can check the guide for GitHub Pages which gives more details on how to deploy the static site using GitHub.