From 6e8bb14567a16b1a9250cc86ad62f1321cf4184d Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sun, 28 Apr 2024 21:00:57 +0300 Subject: [PATCH] docs: fix alignment issues in README --- .github/README.md | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/.github/README.md b/.github/README.md index c12f8b6..26fcdc5 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,9 +1,10 @@
nvf Logo +

-

❄️ nvf

+
-

+

Latest release @@ -22,7 +23,8 @@ Repo Size -

+

+

@@ -36,12 +38,18 @@ Nix code. -
---

+[Get Started]: #get-started +[Documentation]: #documentation +[Help]: #help +[Contribute]: #contributing +[FAQ]: #faq +[Credits]: #credits + **[
 Get Started 
][Get Started]** **[
 Documentation 
][Documentation]** **[
 Help 
][Help]** @@ -51,13 +59,6 @@

-[Get Started]: #get-started -[Documentation]: #documentation -[Help]: #help -[Contribute]: #contributing -[FAQ]: #faq -[Credits]: #credits - --- ## Get Started @@ -106,13 +107,15 @@ featured configuration with `nix` language support by running: nix run github:notashelf/nvf#nix ``` -Please create an issue on the [issue tracker](../../../issues) if you find +[Issues]: https://github.com/NotAShelf/nvf/issues + +Please create an issue on the [issue tracker](issues) if you find the documentation lacking or confusing. I also appreciate any contributions to the documentation. ## Help -You can create an issue on the [issue tracker](../../../issues) to ask questions +You can create an issue on the [issue tracker](issues) to ask questions or report bugs. I am not yet on spaces like matrix or IRC, so please use the issue tracker for now. @@ -121,7 +124,7 @@ tracker for now. I am always looking for new ways to help improve this flake. If you would like to contribute, please read the [contributing guide](CONTRIBUTING.md) before submitting a pull request. You can also create an issue on the -[issue tracker](../../../issues) before submitting a pull request if you would +[issue tracker](issues) before submitting a pull request if you would like to discuss a feature or bug fix. ## FAQ @@ -130,8 +133,7 @@ like to discuss a feature or bug fix.
**A**: Maybe! It is not one of our goals to support each and every Neovim plugin, however, I am always open to new modules and plugin setup additions -to **nvf**. Use the [appropritate issue -template](https://github.com/NotAShelf/nvf/issues/new/choose) and I will +to **nvf**. Use the [appropritate issue template](issues/new/choose) and I will consider a module addition. **Q**: A plugin I need is not available in **nvf**. What to do?