From 58022f9f9c48bbf77fe916feb03d2176c0199916 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Wed, 4 Dec 2024 17:44:30 +0100 Subject: [PATCH] fix md files shredded by mdformat --- docs/community/help.md | 31 +++++++++++++++---------------- docs/community/index.md | 5 +---- docs/examples/index.md | 5 +++++ docs/getting_started.md | 10 +++++----- docs/index.md | 12 +++--------- 5 files changed, 29 insertions(+), 34 deletions(-) diff --git a/docs/community/help.md b/docs/community/help.md index 4c98225..dc9121b 100644 --- a/docs/community/help.md +++ b/docs/community/help.md @@ -6,34 +6,31 @@ icon: material/help-circle ## First steps -!!! tip "Search bar" Use the search bar from this documentation page to find -what you are looking for. +!!! tip + "Search bar" Use the search bar from this documentation page to find + what you are looking for. -!!! tip "Look at the examples" The examples tab has might give you some insides -into how to use the tool. +!!! tip + "Look at the examples" The examples tab has might give you some insides + into how to use the tool. -!!! tip "Mailing list" Our [mailing list][mailing_list] might have some -information about your issue. Search for questions made by previous users of -the potassco tools. You can also [subscribe] to this list to get updates and -join the community. +!!! tip + "Mailing list" Our [mailing list][mailing_list] might have some + information about your issue. Search for questions made by previous users of + the potassco tools. You can also [subscribe] to this list to get updates and + join the community. ## Further help !!! question "Open an Issue" - -``` -Open an [issue][new_issue] describing your problem. + Open an [issue][new_issue] describing your problem. !!! warning To avoid duplicating issues, please search our [issue tracker][issues] and our [mailing list][mailing_list] before filing a new issue. -``` !!! question "Reach out in the mailing list" - -``` -Send an email to the list with your issue. -``` + Send an email to the list with your issue. ## General ASP support @@ -42,3 +39,5 @@ Send an email to the list with your issue. [mailing_list]: https://sourceforge.net/p/potassco/mailman/potassco-users/ [subscribe]: https://sourceforge.net/projects/potassco/lists/potassco-users/ [support_page]: https://potassco.org/support/ +[new_issue]: https://github.com/potassco/fillname/issues/new +[issues]: https://github.com/potassco/fillname/issues diff --git a/docs/community/index.md b/docs/community/index.md index 4e3383d..d230d56 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -26,7 +26,4 @@ Your participation keeps our project thriving. Thank you for being part of our community! !!! info - -``` -*fillanme* is part of the [Potassco] suit (which is the home of *clingo* and the other ASP tools) -``` + *fillname* is part of the [Potassco](https://potassco.org) suite. diff --git a/docs/examples/index.md b/docs/examples/index.md index 6cb6c1a..bff9d10 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,3 +1,8 @@ +--- +hide: + - navigation +--- + # Examples Welcome to the **Examples** section of our documentation! 🎉 diff --git a/docs/getting_started.md b/docs/getting_started.md index 3c5e733..cf57665 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -1,18 +1,20 @@ +--- +hide: + - navigation +--- + # Getting started ## Installation === "Pip" -```` ```console pip install fillname ``` -```` === "Development mode" -```` ```console git clone https://github.com/potassco/fillname.git/ cd fillname @@ -20,9 +22,7 @@ pip install -e .[all] ``` !!! warning - Use only for development purposes -```` ## Usage diff --git a/docs/index.md b/docs/index.md index 5221cc5..2644602 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,16 +1,10 @@ --- -title: Home hide: - - navigation - - toc + - navigation + - toc --- # fillname -*fillname* fill description - !!! info - -``` -*fillname* is part of the [Potassco] suit (which is the home of *clingo* and the other ASP tools) -``` + *fillname* is part of the [Potassco](https://potassco.org) suite.