https://github.com/sanifhimani/docyard
Generate beautiful documentation sites from Markdown
https://github.com/sanifhimani/docyard
documentation ruby
Last synced: 7 days ago
JSON representation
Generate beautiful documentation sites from Markdown
- Host: GitHub
- URL: https://github.com/sanifhimani/docyard
- Owner: sanifhimani
- License: mit
- Created: 2025-11-03T02:19:41.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-01-30T16:59:50.000Z (26 days ago)
- Last Synced: 2026-01-31T09:40:51.479Z (25 days ago)
- Topics: documentation, ruby
- Language: Ruby
- Homepage: http://docyard.dev/
- Size: 3.14 MB
- Stars: 27
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Markdown to docs in seconds. No Node.js required.
Docs ·
Quickstart ·
Changelog
---
## Install
```bash
gem install docyard
docyard init
docyard serve
```
Open `localhost:4200`. Edits reload instantly.
## Example
```markdown
:::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](https://docyard.dev/write-content/components)
## Build
```bash
docyard build
```
Static HTML, search index, sitemap, and social cards in `dist/`. Deploy anywhere.
## Docs
[docyard.dev](https://docyard.dev) is built with Docyard.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
[MIT](LICENSE)