Project

docyard

0.01
A long-lived project that still receives updates
Generate beautiful documentation sites from Markdown
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

~> 2.5
~> 3.0
~> 1.6
~> 3.0
~> 4.0
~> 1.4
~> 1.26
~> 7.0
~> 1.0
~> 1.2
 Project Readme

Docyard

Markdown to docs in seconds. No Node.js required.

CI Gem Version License

Docs · Quickstart · Changelog


Install

gem install docyard
docyard init
docyard serve

Open localhost:4200. Edits reload instantly.

Example

:::note
Requires Ruby 3.2 or higher.
:::

:::tabs
== macOS
brew install ruby

== Linux
sudo apt install ruby-full
:::

Callouts, tabs, steps, cards, code groups, accordions, and more. See all components

Build

docyard build

Static HTML, search index, sitemap, and social cards in dist/. Deploy anywhere.

Docs

docyard.dev is built with Docyard.

Contributing

See CONTRIBUTING.md.

License

MIT