Riverpod Gen Shortcuts

Documentation tools

Riverpod Gen Shortcuts

Flutter code generation made effortless. A clean documentation experience for providers, notifiers, snippets, and workflows.

Get StartedView on GitHub

What this gives you

Simple, readable documentation

The layout focuses on clarity first — no unnecessary decoration, just clean structure and readable examples.

Fast provider boilerplate

Generate provider code quickly with minimal setup.

Type-safe generated output

Everything stays predictable with strong typing.

Practical testing patterns

Easily test using overrides and controlled states.

Quick example

A simple provider in practice

This shows how the generator simplifies your setup. Keep the example close to the explanation so users don’t lose context.

todo_provider.dart
// With riverpod_generator — just annotate!
@riverpod
Future<List<Todo>> todoList(TodoListRef ref) async {
  final response = await http.get('https://api.example.com/todos');
  return response.body.map(Todo.fromJson).toList();
}

// Generated provider is ready to use:
// final provider = todoListProvider;

Content format

Keep visuals minimal

Code should always be the primary focus. Use visuals only when they add real clarity.

Use images only when necessary

Only include visuals when they improve understanding.

Keep animations minimal

Avoid distractions — motion should support content.

Prioritize code readability

Make examples easy to scan and understand quickly.