Surround diagrams with code fences

Markdown processors omit extra white space by default, so we need to put diagrams inside code fences
praja · Mar 13, 2023 · 7424a1b · 7424a1b
1 parent c2df062
commit 7424a1b
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.1.2
+#### Fixes
+* Diagram formatting in `viewmodel` documentation
+
 ## 0.1.1
 #### 💫 New
 * `example` published to pub.dev

diff --git a/lib/viewmodel.dart b/lib/viewmodel.dart
@@ -15,6 +15,8 @@ import 'package:flutter/widgets.dart';
 /// `ViewModel`s allow for UI Widgets to be as simple as possible
 /// UI only talks and listens to the `ViewModel`, the rest of
 /// the application code is abstracted away.
+///
+/// ```
 ///                               ┌─────────┐
 ///                  ┌───────────►│ Network │
 ///                  │            └─────────┘
@@ -24,6 +26,7 @@ import 'package:flutter/widgets.dart';
 ///                  │            ┌──────────┐
 ///                  └───────────►│ MemCache │
 ///                               └──────────┘
+/// ```
 /// One can choose to have more abstractions between the `ViewModel`
 /// and network, database and memcache like `Repository`, `Service`
 /// to simplify the logic inside a `ViewModel` or to hold some state

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: jetpack
 description: A set of abstractions, utilities inspired from android Jetpack to help manage state in flutter applications.
-version: 0.1.1
+version: 0.1.2
 homepage: https://github.com/praja/jetpack
 
 environment: