From 834f806d3ca3f75cd8c94988c9f23ae085b58845 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Joly?= <l@131719.xyz>
Date: Mon, 22 Aug 2022 00:24:50 +0100
Subject: [PATCH] docs: improve the Readme and generate homepage

---
 Readme.md | 49 ++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 44 insertions(+), 5 deletions(-)

diff --git a/Readme.md b/Readme.md
index a94742f..cc360e9 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,12 +1,45 @@
-# bepo.nvim
+<!-- insert
+---
+title: "bepo.nvim"
+date: 2022-02-21T10:02:37
+description: "⌨️ Mappings for the bepo layout in Lua"
+repo_url: "https://github.com/cljoly/bepo.nvim"
+aliases:
+- /bepo.nvim
+tags:
+- NeoVim
+- Lua
+- Plugin
+- Bepo
+- Lisp
+- Fennel
+#images:
+#- /telescope-repo-nvim/opengraph.png
+#- /telescope-repo-nvim/opengraph.webp
+---
+{{< github_badge >}}
 
-*Work in progress, see the [sources](https://github.com/cljoly/bepo.nvim/blob/main/fnl/bepo.fnl)*
+{{< rawhtml >}}
+<div class="badges">
+{{< /rawhtml >}}
+end_insert -->
+<!-- remove -->
+# ⌨️ bepo.nvim
+<!-- end_remove -->
 
-Remap for the bepo layout in Lua, inspired by https://github.com/michamos/vim-bepo
+![Neovim version](https://img.shields.io/badge/Neovim-0.5-57A143?style=flat&logo=neovim) [![](https://img.shields.io/badge/powered%20by-riss-lightgrey)](https://cj.rs/riss) ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/cljoly/bepo.nvim?color=darkgreen&sort=semver)
 
-It aims to be faster (takes only 0.4ms at startup on my machine, while vim-bepo requires 1.6ms)
+<!-- insert
+{{< rawhtml >}}
+</div>
+{{< /rawhtml >}}
+end_insert -->
 
-## Example Use Case
+Mappings for the [bepo][] layout in Lua, inspired by [vim-bepo][vb]
+
+It aims to be faster (takes only 0.4ms at startup on my machine, while [vim-bepo][vb] requires 1.6ms) and more customizable (see `:help bepo.nvim-cherry-pick`)
+
+## Example Use
 
 You should call the extension early in your config, so that you can erase mappings later (or with later extensions) more easily.
 
@@ -21,3 +54,9 @@ require("bepo").tabs()
 require("bepo").easy_access()
 require("bepo").window()
 ```
+
+See [the help file][help] for more details and the mappings installed.
+
+[vb]: https://github.com/michamos/vim-bepo
+[help]: https://github.com/cljoly/bepo.nvim/blob/main/doc/bepo-nvim.txt
+[bepo]: https://bepo.fr/