# Trifle::Docs

## Content
# Trifle::Docs

[![Gem Version](https://badge.fury.io/rb/trifle-docs.svg)](https://rubygems.org/gems/trifle-docs)
[![Ruby](https://github.com/trifle-io/trifle-docs/workflows/Ruby/badge.svg?branch=main)](https://github.com/trifle-io/trifle-docs)

`Trifle::Docs` is a lightweight router and renderer for static documentation inside Ruby apps.

## What it does

- Maps a folder of Markdown/textile/static files to URLs.
- Generates metadata (TOC, breadcrumbs, updated_at) for navigation and search.
- Lets you plug in custom harvesters for new formats.

## Quick example

```ruby
Trifle::Docs.configure do |config|
  config.path = Rails.root.join('docs')
  config.register_harvester(Trifle::Docs::Harvester::Markdown)
end

html = Trifle::Docs.content(url: 'getting_started')
meta = Trifle::Docs.meta(url: 'getting_started')
```

## What to expect

- `content` returns rendered HTML.
- `meta` includes `toc`, `breadcrumbs`, and `updated_at`.
- URLs follow your folder structure.

## Next steps

- [Getting Started](/trifle-docs/getting_started)
- [Configuration](/trifle-docs/configuration)
- [Usage](/trifle-docs/usage)
- [Harvesters](/trifle-docs/harvesters)
- [Guides](/trifle-docs/guides)