Steps

Guide users through a process with numbered steps.

Basic Usage

1

Install Docyard

Install the gem from RubyGems:

gem install docyard
2

Create a Project

Generate a new documentation site:

docyard init my-docs
cd my-docs
3

Start the Server

Run the development server:

docyard serve

Open http://localhost:4200 to see your site.

With Rich Content

Each step supports full Markdown including code blocks, lists, tables, and callouts:

1

Configure Your Site

Edit docyard.yml to customize your site:

docyard.yml 
title: My Documentation
description: Docs for my project
branding:
  color: "#3b82f6"
2

Organize Your Content

Create pages in the docs/ directory:

File URL
docs/index.md /
docs/guide.md /guide
docs/api/auth.md /api/auth
3

Add Navigation

Define your sidebar in _sidebar.yml:

_sidebar.yml 
- getting-started:
    text: Get Started
    icon: rocket-launch
    items:
      - quickstart
      - installation
4

Build and Deploy

Build your site for production:

docyard build

Upload the dist/ directory to any static host.

Minimal Steps

Steps can be simple with just titles:

1

Clone the repository

2

Install dependencies

3

Run the tests

4

Deploy to production

Syntax 

:::steps
### First Step Title

Content for the first step.

### Second Step Title

Content for the second step.

### Third Step Title

Content for the third step.
:::

Reference

Feature Syntax Description
Container :::steps Required. Wraps all steps
Step heading ### Title Required. Creates a new step
Content Markdown Optional. Any Markdown after the heading

Steps are automatically numbered starting from 1.

Edit this page
Last updated
Built with Docyard