From f41af0e7d5ee0c7994f1c72e7c9c31ae9e89dd72 Mon Sep 17 00:00:00 2001 From: Moul <moul@moul.re> Date: Tue, 17 Dec 2024 16:24:19 +0100 Subject: [PATCH] Introduce main page: index and empty usage (#433) --- docs/index.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++ docs/usage.md | 3 +++ mkdocs.yml | 3 ++- 3 files changed, 73 insertions(+), 1 deletion(-) create mode 100644 docs/index.md create mode 100644 docs/usage.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..69ae6125 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,68 @@ +--- +hide: + - toc + - navigation +--- + +<center> +# Welcome + +{ width="200" } + +Welcome to Silkaj documentation + +[Install :material-package-down:](/install){ .md-button .md-button--primary } [Usage :material-keyboard-outline:](/usage){ .md-button .md-button--primary } + +## What is Silkaj? + +Silkaj is a command line client for [Äž1](https://duniter.org/g1/) libre currency powered by [Duniter software](https://duniter.org/). + +<div class="grid cards" markdown> + +- :fontawesome-solid-money-bill-1-wave:{ .lg .middle} __Money management__ + + ______________________________________________________________________ + + Transfer money, check your balance, and history stand. + +- :material-vector-polyline:{ .lg .middle } __Web-of-Trust__ + + ______________________________________________________________________ + + Manage your certifications, membership, and the revocation document + +- :octicons-terminal-16:{ .lg .middle } __CLI interface__ + + ______________________________________________________________________ + + Silkaj is built around a command line interface design. + +- :material-book-open-variant:{ .lg .middle} __RTM compatible__ + + ______________________________________________________________________ + + Silkaj is compatible with the [Relative Theory of Money](https://en.trm.creationmonetaire.info/) + and includes Äž1 Monetary License. + +- :material-scale-balance:{ .lg .middle } __Free software__ + + ______________________________________________________________________ + + Silkaj is licensed under :material-copyleft: :simple-gnu: [GNUÂ AGPL v3](https://www.gnu.org/licenses/agpl-3.0.html). + +- :material-raspberry-pi:{ .lg .middle } __Low requirements__ + + ______________________________________________________________________ + + Written with Python, Silkaj is built with low requirements in mind. + +<!-- +- Authentication method + + ______________________________________________________________________ + + Wallet Import Format (WIF) is implemented. +--> + +</div> +</center> diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 00000000..26844248 --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,3 @@ +# Usage + +Documentation to be written. diff --git a/mkdocs.yml b/mkdocs.yml index 10d2c51f..03e3a04b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,9 +46,10 @@ markdown_extensions: - toc: permalink: true nav: - - index.md + - Home: index.md - Installation: install.md - Usage: + - usage.md - multi-recipients_transfers_and_automation.md - DeathReaper: deathreaper.md - Blog: -- GitLab