Skip to content

sanifhimani/docyard

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

About

Generate beautiful documentation sites from Markdown

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •