From 6095c996e18ba20389c60e234bb28b27658ff8cd Mon Sep 17 00:00:00 2001 From: NAHO <90870942+trueNAHO@users.noreply.github.com> Date: Sat, 23 Dec 2023 01:23:06 +0100 Subject: [PATCH] docs: uniformly replace 'bash' tags with 'console' --- README.md | 2 +- docs/HowTo.md | 4 ++-- docs/quickstart.md | 16 ++++++++-------- docs/reference.md | 6 +++--- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1bf4488..88d80a2 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ If you'd saved this configuration in /tmp/disko-config.nix, and wanted to create a disk named /dev/nvme0n1, you would run the following command to partition, format and mount the disk. -```bash +```console sudo nix --experimental-features "nix-command flakes" run github:nix-community/disko -- --mode disko /tmp/disko-config.nix ``` diff --git a/docs/HowTo.md b/docs/HowTo.md index 0286889..ce303e1 100644 --- a/docs/HowTo.md +++ b/docs/HowTo.md @@ -45,7 +45,7 @@ If you use nix flakes support: First add it to [niv](https://github.com/nmattia/niv): -```bash +```console niv add nix-community/disko ``` @@ -63,7 +63,7 @@ Then add the following to your configuration.nix in the `imports` list: As root run: -```bash +```console nix-channel --add https://github.com/nix-community/disko/archive/master.tar.gz disko nix-channel --update ``` diff --git a/docs/quickstart.md b/docs/quickstart.md index ee09ccc..82e794a 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -47,7 +47,7 @@ the NixOS manual. Boot the machine from this USB drive. Identify the name of your system disk by using the `lsblk` command as follows: -```bash +```console lsblk ``` @@ -73,7 +73,7 @@ from the url you noted above, using the `-o` option to save the file as disko-config.nix. Your commands would look like this if you had chosen the hybrid layout: -```bash +```console cd /tmp curl https://raw.githubusercontent.com/nix-community/disko/master/example/hybrid.nix -o /tmp/disko-config.nix ``` @@ -84,7 +84,7 @@ Inside the disko-config.nix the device needs to point to the correct disk name. Open the configuration in your favorite editor i.e.: -```bash +```console nano /tmp/disko-config.nix ``` @@ -106,14 +106,14 @@ The following step will partition and format your disk, and mount it to `/mnt`. **Please note: This will erase any existing data on your disk.** -```bash +```console sudo nix --experimental-features "nix-command flakes" run github:nix-community/disko -- --mode disko /tmp/disko-config.nix ``` After the command has run, your file system should have been formatted and mounted. You can verify this by running the following command: -```bash +```console mount | grep /mnt ``` @@ -140,7 +140,7 @@ command to generate an initial `configuration.nix`. You will be supplying the file system configuration details from `disko-config.nix`. Your CLI command to generate the configuration will be: -```bash +```console nixos-generate-config --no-filesystems --root /mnt ``` @@ -148,7 +148,7 @@ This will create the file `configuration.nix` in `/mnt/etc/nixos`. b) Move the `disko` configuration to /etc/nixos -```bash +```console mv /tmp/disko-config.nix /mnt/etc/nixos ``` @@ -197,7 +197,7 @@ take care of that automatically. f) Finish the installation and reboot your machine, -```bash +```console nixos-install reboot ``` diff --git a/docs/reference.md b/docs/reference.md index 7a916f2..935eaa4 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -53,13 +53,13 @@ generate disk images: 1. **Build the disko image script:** Replace `mySystem` in the command below with your specific system configuration name: - ```bash + ```console nix build .#nixosConfigurations.mySystem.config.system.build.diskoImagesScript ``` 2. **Execute the result file:** Execute the generated result file. Running `./result --help` will output the available options: - ```bash + ```console ./result --help Usage: $script [options] @@ -85,7 +85,7 @@ generate disk images: - For virtual drive use, define the image size in your Disko configuration: - ```bash + ```console disko.devices.disk..imageSize = "32G"; # Set your preferred size ```