From 7820cc65203e67b148b6a7bf6a67e6b2e9137888 Mon Sep 17 00:00:00 2001 From: Moul <moul@moul.re> Date: Tue, 17 Dec 2024 16:24:14 +0100 Subject: [PATCH] Fix code block syntax highlight activation side effects (#433) Remove shells lexemes making strange color highlight, disrupting the reading https://squidfunk.github.io/mkdocs-material/reference/code-blocks/ --- docs/blog/posts/v0.10.0.md | 8 ++++---- docs/blog/posts/v0.10.0rc.md | 20 +++++++++---------- docs/blog/posts/v0.11.0.md | 17 ++++++++-------- docs/blog/posts/v0.11.0rc0.md | 8 ++++---- docs/blog/posts/v0.8.md | 16 +++++++-------- docs/blog/posts/v0.9.0rc.md | 4 ++-- docs/blog/posts/v0.9.md | 14 ++++++------- ...lti-recipients_transfers_and_automation.md | 4 ++-- 8 files changed, 45 insertions(+), 46 deletions(-) diff --git a/docs/blog/posts/v0.10.0.md b/docs/blog/posts/v0.10.0.md index 23465949..c1925d86 100644 --- a/docs/blog/posts/v0.10.0.md +++ b/docs/blog/posts/v0.10.0.md @@ -35,7 +35,7 @@ The complete lifecycle of the revocation document and its storage in a file is n The `revocation` command comes with four sub-commands: -```bash +``` silkaj revocation --help Usage: silkaj revocation [OPTIONS] COMMAND [ARGS]... @@ -61,7 +61,7 @@ In the future, we will implement more commands using this feature, since we now You can now define a file following this format. For instance, a file named `recipients.txt`: -```txt +```title="recipients.txt" <ABSOLUTE|RELATIVE> # comment 1 @@ -76,7 +76,7 @@ The checksum can be append to the pubkey to have its integrity checked. And pass it to `silkaj tx` command as follow: -```bash +``` silkaj --gtest tx -f recipients.txt ``` @@ -89,7 +89,7 @@ This update brings fixes and improvements on the existing languages and brings a The display is now only displaying the embedded license files in the console, since it’s available in six up-to-date languages. -```bash +``` silkaj license In which language would you like to display Äž1 monetary license? (es, en, eo, it, fr, pt) [en]: fr ``` diff --git a/docs/blog/posts/v0.10.0rc.md b/docs/blog/posts/v0.10.0rc.md index 4523c686..dae02ae1 100644 --- a/docs/blog/posts/v0.10.0rc.md +++ b/docs/blog/posts/v0.10.0rc.md @@ -20,19 +20,19 @@ We are pleased to announce Silkaj v0.10.0 release candidate, and we would be hap You can install this pre-release version from PyPI or from a Docker image. To install the Python package, run following command: -```bash +``` pip3 install silkaj --user --upgrade --pre ``` To [install and run Silkaj from the Docker image](/docker): -```bash +``` sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.10.0rc0 ``` Run Silkaj from outside the image: -```bash +``` sudo docker run -it registry.duniter.org/clients/python/silkaj/release/pip:v0.10.0rc0 silkaj info ``` @@ -50,7 +50,7 @@ Make sure you test on Äž1-Test network to avoid any revocation or loss of money `revocation` command handle the revocation document in an extended way. Check the sub-commands: -```bash +``` silkaj revocation --help ``` @@ -58,7 +58,7 @@ Make sure you are able to create new identities before proceeding. Create a revocation file with an existing identity. Verify the generated file, and publish it! -```bash +``` silkaj --gtest revocation save revocation_test.txt silkaj --gtest revocation verify revocation_test.txt silkaj --gtest revocation publish revocation_test.txt @@ -66,7 +66,7 @@ silkaj --gtest revocation publish revocation_test.txt Or directly all the previous steps with one command: -```bash +``` silkaj --gtest revocation revoke ``` @@ -74,7 +74,7 @@ silkaj --gtest revocation revoke Check Äž1 monetary license get displayed correctly in any language and in any configuration: workstation or headless computers. -```bash +``` silkaj license silkaj --g1-license-web license ``` @@ -84,7 +84,7 @@ silkaj --g1-license-web license Silkaj’s network code layer have been completely rewritten, an other HTTP library is used, the asynchronous propery has been dropped, and the documents classes have been refactored. Try any commands requesting information from the network or try sending any document. -```bash +``` silkaj info silkaj -ep <hostname>:<port> membership ``` @@ -93,7 +93,7 @@ silkaj -ep <hostname>:<port> membership You can now define `recipients.txt` file following this format: -```txt +```title="recipients.txt" ABSOLUTE # moul-test @@ -105,7 +105,7 @@ ABSOLUTE And pass it to `silkaj tx` command as follow: -```bash +``` silkaj --gtest tx -f recipients.txt ``` diff --git a/docs/blog/posts/v0.11.0.md b/docs/blog/posts/v0.11.0.md index dfff2057..1bc2398b 100644 --- a/docs/blog/posts/v0.11.0.md +++ b/docs/blog/posts/v0.11.0.md @@ -38,7 +38,7 @@ Silkaj documentation has been updated to suggest `pipx` instead of `pip`. In short, you can install Silkaj via `pipx` this way: -```bash +``` sudo apt install pipx libsodium23 pipx install silkaj ``` @@ -50,7 +50,7 @@ For a comprehensive documentation, check the [installation documentation](/insta The commands have been grouped into following groups: `blockchain`, `money`, and `wot`. The other commands not related to these topics have been kept at the root of the CLI tree. -```sh +``` silkaj --help about Display program information authentication Generate authentication file @@ -61,7 +61,7 @@ silkaj --help wot Web-of-Trust related commands ``` -```sh +``` silkaj blockchain --help blocks Display blocks: default: 0 for current window size difficulty Display the current Proof of Work difficulty level to... @@ -69,14 +69,14 @@ silkaj blockchain --help verify Verify blocks’ signatures. ``` -```sh +``` silkaj money --help balance Get wallet balance history Display transaction history transfer Transfer money ``` -```sh +``` silkaj wot --help certify Send certification lookup User identifier and public key lookup @@ -87,7 +87,7 @@ silkaj wot --help In this process following commands have been renamed: -```sh +``` diffi −> difficulty tx −> transfer cert −> certify @@ -104,7 +104,7 @@ The migration has been done. You will probably notice differences in the table s Before, with `tabulate`: -```bash +``` | uid | blocks | percent | |-------------+----------+-----------| | vit2 | 33 | 33.0 | @@ -116,7 +116,7 @@ Before, with `tabulate`: Now, with `texttable`: -```bash +``` │─────────────│────────│─────────│ │ uid │ blocks │ percent │ │â•â•â•â•â•â•â•â•â•â•â•â•â•â”‚â•â•â•â•â•â•â•â•â”‚â•â•â•â•â•â•â•â•â•â”‚ @@ -126,7 +126,6 @@ Now, with `texttable`: │ jytou4-test │ 10 │ 10 │ │ jytou5-test │ 8 │ 8 │ │─────────────│────────│─────────│ - ``` ## Network diff --git a/docs/blog/posts/v0.11.0rc0.md b/docs/blog/posts/v0.11.0rc0.md index f0a10822..79ba9c48 100644 --- a/docs/blog/posts/v0.11.0rc0.md +++ b/docs/blog/posts/v0.11.0rc0.md @@ -24,20 +24,20 @@ To install the Python package, run following command: Install `pipx` from the [installation documentation](/install): -```bash +``` sudo apt install pipx pipx install --pip-args "\--pre" silkaj ``` To [install and run Silkaj from the Docker image](/docker): -```bash +``` sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.11.0rc0 ``` Run Silkaj from outside the image: -```bash +``` sudo docker run -it registry.duniter.org/clients/python/silkaj/release/pip:v0.11.0rc0 silkaj ``` @@ -60,7 +60,7 @@ Silkaj commands have been reorganized into following groups: `blockchain`, `mone Some commands not related to these contexts have been kept in the top-level group. Tell us if the new CLI design with sub-sub-commands compared to the previous one with all the commands at the top-level instead fits best, is less convenient, is following a more structured logic. -```bash +``` Commands: about Display program information authentication Generate authentication file diff --git a/docs/blog/posts/v0.8.md b/docs/blog/posts/v0.8.md index 85ce0f32..c53696b9 100644 --- a/docs/blog/posts/v0.8.md +++ b/docs/blog/posts/v0.8.md @@ -39,7 +39,7 @@ After the transaction and the certification commands, the much awaited `membersh Users can send their first membership request to be a certified member of the Äž1 community. As certified members have to renew their membership each year, this command allows to send the renewal application in question. It displays the expiration date of the current membership and indicates the identification blockstamp of the user. In the event a user forgets that they have already sent a membership request, a pop up displays if there is a pending membership request in the mempool. -```bash +``` silkaj membership Please enter your Scrypt Salt (Secret identifier): Please enter your Scrypt password (masked): @@ -72,7 +72,7 @@ Do you confirm sending a membership document for this identity? [y/N]: When using the commands `wot`, `cert`, and `membership`, Silkaj used to select the first identity on the list. As this can lead to fishing, we added a new feature to pick the identity of your choice. Now, you can use the `uid` and the `pubkey` to certify an identity and study its status in the Web of Trust. Please note that identities can have the same user identifier and the same public key. -```bash +``` silkaj -gt wot moul | id | uid | pubkey | timestamp | |------+-----------+--------------------------------------------------+-----------------------| @@ -105,19 +105,19 @@ v0.8.0 comes with three **breaking changes** and four small options: The follow examples illustrates the change operated on the CLI. With the previous version of Silkaj, the following procedure was operated to send one unit to `pubkey1` and `pubkey2`: -```bash +``` silkaj tx --amount 1 --output <pubkey>1!<checksum1>:<pubkey2>!<checksum2> ``` With the current version of Silkaj, the following procedures are operated to send one unit to `pubkey1` and two units to `pubkey2`: -```bash +``` silkaj tx --amount 1 --recipient <pubkey1>:<checksum1> --amount 2 --recipient <pubkey2>:<checksum2> ``` With small options: -```bash +``` silkaj tx -a 1 -r <pubkey1>:<checksum1> -a 2 -r <pubkey2>:<checksum2> ``` @@ -129,7 +129,7 @@ We merged the relative and absolute amounts into one cell. This applies to the c To send a different amount of Äž1 to multi-recipient proceed following: -```bash +``` silkaj tx -d 1 -d 2 \ -r CrznBiyq8G4RVUprH9jHmAw1n1iuzw8y9FdJbrESnaX7 \ -r d88fPFbDdJXJANHH7hedFMaRyGcnVZj9c5cDaE76LRN:FVm \ @@ -164,7 +164,7 @@ Do you confirm sending this transaction? [yes/no]: The balance of a given public key is now displayed in a table. Bellow you can find an example of such a display. -```bash +``` silkaj balance 78ZwwgpgdH5uLZLbThUQH7LKwPgjMunYfLiCfUCySkM8 â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•¤â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•• │ Balance of pubkey │ 78ZwwgpgdH5uLZLbThUQH7LKwPgjMunYfLiCfUCySkM8:4VT │ @@ -191,7 +191,7 @@ Cf [Forum topic](https://forum.duniter.org/t/duniter-utilise-une-ancienne-versio To verify blocks proceed following: -```bash +``` silkaj verify Processing blocks verification [####################################] 100% Within 0-342803 range, blocks with a wrong signature: 15144 31202 85448 87566 90830 109327 189835 199172 221274 253582 diff --git a/docs/blog/posts/v0.9.0rc.md b/docs/blog/posts/v0.9.0rc.md index 394e2129..d1ff4f06 100644 --- a/docs/blog/posts/v0.9.0rc.md +++ b/docs/blog/posts/v0.9.0rc.md @@ -17,7 +17,7 @@ We are pleased to publish a release candidate of Silkaj v0.9.0, and we would be To install this pre-release version from PyPI, use this command: -```sh +``` pip3 install silkaj --user --upgrade --pre ``` @@ -25,7 +25,7 @@ Please test it globally, and check the changelog which contains the changes whic Pay a special attention to the transaction part where a part of the algorithm changed. There are new options on following commands: -```sh +``` silkaj history --full-pubkey silkaj --dry-run cert silkaj --dry-run/--display membership diff --git a/docs/blog/posts/v0.9.md b/docs/blog/posts/v0.9.md index 78bc4849..88234665 100644 --- a/docs/blog/posts/v0.9.md +++ b/docs/blog/posts/v0.9.md @@ -33,7 +33,7 @@ Now the non-member user identifier are displayed. The command now uses same algorithm as `choose_identity()` which relies exclusively on `/wot/lookup` BMA's path. The command has been renamed to `lookup` to represent more closely what it does. This command renaming will also allow to introduce the future `identity` command. -```bash +``` silkaj lookup titi Public keys or user id found matching 'titi': @@ -53,7 +53,7 @@ Public keys or user id found matching 'titi': The `history` command adds a new option to display the whole public keys `--full-pubkey`: -```bash +``` silkaj -gt history 5B8iMAzq1dNmFe3ZxFTBQkqhq4fsztg1gZvxHXCk1XYH --full-pubkey Transactions history from: moul-test 5B8iMAzq1dNmFe3ZxFTBQkqhq4fsztg1gZvxHXCk1XYH:baK @@ -73,7 +73,7 @@ Current balance: 9012407.83 ÄžTest, 161.34 UD ÄžTest on the 2021-04-09 15:16:42 #### `balance` command is now displaying corresponding member identity user identifier -```bash +``` silkaj -gt balance 5B8iMAzq1dNmFe3ZxFTBQkqhq4fsztg1gZvxHXCk1XYH â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•¤â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•• │ Balance of pubkey │ 5B8iMAzq1dNmFe3ZxFTBQkqhq4fsztg1gZvxHXCk1XYH:baK │ @@ -93,7 +93,7 @@ It can be used for debugging, safety, or curiosity purposes. This option has only been implemented on the `cert` and the `membership` commands for now. The option should be available in next releases for the three others send-documents commands. -```bash +``` silkaj --gtest --auth-file --display cert KapisTest â•’â•â•â•â•â•â•â•â•â•¤â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•¤â•â•â•â•â•¤â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•• │ Cert │ Issuer │ –> │ Recipient: Published: #block-hash date │ @@ -118,7 +118,7 @@ Do you confirm sending this certification? [y/N]: y Certification successfully sent. ``` -```bash +``` silkaj --gtest --auth-file --display membership â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•¤â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•• │ Expiration date of current membership │ in 2 months │ @@ -153,13 +153,13 @@ Membership successfully sent Before: -```bash +``` silkaj membership --dry-run ``` Now: -```bash +``` silkaj --dry-run membership ``` diff --git a/docs/multi-recipients_transfers_and_automation.md b/docs/multi-recipients_transfers_and_automation.md index a501e08a..b4eeaf6d 100644 --- a/docs/multi-recipients_transfers_and_automation.md +++ b/docs/multi-recipients_transfers_and_automation.md @@ -26,7 +26,7 @@ The file content should be prefixed with `RELATIVE` or `ABSOLUTE` so the amounts Finally, you just have to run following command: -```bash +``` silkaj -a <account_name> money transfer --file recipients.txt ``` @@ -34,7 +34,7 @@ silkaj -a <account_name> money transfer --file recipients.txt In case you want to automate a transfer on a regural basis, on the first day of the month in this example, you can set a `crontab` on your machine (preferably a machine running 7/24): -```bash +``` 0 0 1 * * silkaj -a <account_name> money transfer --file recipients.txt --yes ``` -- GitLab