Add tooling to preview README locally

mise.toml

@@ -54,6 +54,18 @@ description = 'Show outdated mix dependencies'
 run = ['mix hex.outdated --all']
 hide = true
 
+# TOOLING
+
+[tasks.gh-markdown-preview-extension-install]
+description = 'Install a gh extension to preview GH-flavoured markdown files locally'
+run = ['gh extension install thiagokokada/gh-gfm-preview']
+hide = true
+
+[tasks.gh-markdown-preview-extension-update]
+description = 'Update the gh extension to preview GH-flavoured markdown files locally'
+run = ['gh extension upgrade gfm-preview']
+hide = true
+
 # PUBLIC TASKS
 
 # DEPENDENCIES
@@ -63,7 +75,12 @@ depends = ['npm-outdated', 'tailwind-outdated', 'mix-outdated']
 description = 'Show outdated dependencies'
 
 [tasks."deps:update"]
-depends = ['npm-update', 'tailwind-update', 'mix-update']
+depends = [
+  'npm-update',
+  'tailwind-update',
+  'mix-update',
+  'gh-markdown-preview-extension-update',
+]
 description = 'Update dependencies'
 
 # SETUP
@@ -77,7 +94,11 @@ mix hex.repo add fluxon https://repo.fluxonui.com \
 """
 
 [tasks."dev:setup"]
-depends = ['npm-install', 'fluxon-add-repo']
+depends = [
+  'npm-install',
+  'fluxon-add-repo',
+  'gh-markdown-preview-extension-install',
+]
 description = 'Install dependencies and setup the database'
 run = ['mix setup']
 
@@ -129,6 +150,10 @@ run = 'mix test'
 description = 'Run the application attached to an IEx console'
 run = 'iex -S mix phx.server'
 
+[tasks."dev:readme-preview"]
+description = 'Preview the README file via a GH flavoured markdown rendered'
+run = 'gh gfm-preview README.md'
+
 # DOCKER
 
 [tasks."docker:build"]