From d0062aeff4e3f40104afa8411a7cf91afb13cad9 Mon Sep 17 00:00:00 2001 From: Kate Temkin Date: Sat, 27 Apr 2024 20:32:25 -0600 Subject: [PATCH] content: add install page (incomplete) --- TODO.md | 4 +- config.yaml | 7 +- content/add-to-config.md | 11 ++ content/install.md | 101 ++++++++++++++++++ .../lix/assets/scss/sections/blog-single.scss | 5 + 5 files changed, 125 insertions(+), 3 deletions(-) create mode 100644 content/add-to-config.md create mode 100644 content/install.md diff --git a/TODO.md b/TODO.md index ece469c5..0c207599 100644 --- a/TODO.md +++ b/TODO.md @@ -3,6 +3,7 @@ TODO List ## Misc +- Fix the TODO FIXME section of existing installs. - Figure out what to replace the location section with. - Fill out the "contact us" section on the main page. - Figure out any legalese we need on the main page. @@ -13,8 +14,7 @@ TODO List ## Pages - Create the `/install` page. -- Create a subsection for using Lix on existing NixOS, and link it to the box. -- Create a "Why Lix" section on `/about` and link to it. +- Create the `/resources` page, with resources for learning Nix. - Create the /team page and include CoI declarations. - Figure out where to link the "Docs" link to. - Create a /community page linking to matrix. diff --git a/config.yaml b/config.yaml index ba312dc6..3b2072c1 100644 --- a/config.yaml +++ b/config.yaml @@ -60,7 +60,7 @@ menus: buttons: - name: "Install Lix" - url: "/#" + url: "/install" weight: 5 pre: "btn btn-primary text-light" @@ -93,3 +93,8 @@ menus: taxonomies: series: "series" tags: "tags" + +markup: + goldmark: + renderer: + unsafe: true diff --git a/content/add-to-config.md b/content/add-to-config.md new file mode 100644 index 00000000..4c76cc60 --- /dev/null +++ b/content/add-to-config.md @@ -0,0 +1,11 @@ +--- +title: "Adding Lix to Your Config" +description: "or: how to make your existing configruation Delicious" +date: "2024-04-27" +author: "Lix Team" +--- + +## Flake-based Configurations + + +## Non-Flake Configurations diff --git a/content/install.md b/content/install.md new file mode 100644 index 00000000..90909a3b --- /dev/null +++ b/content/install.md @@ -0,0 +1,101 @@ +--- +title: "Installing Lix" +description: "or: how to make your configuration Delicious" +date: "2024-04-27" +author: "Lix Team" +--- + +Whether you're a new or returning user, **we're thrilled you've decided to pick up Lix!** + +Lix works out-of-the-box on most Linux and MacOS systems, including with system management tools +such as [home-manager](https://github.com/nix-community/home-manager) and +[nix-darwin](https://github.com/LnL7/nix-darwin) -- but, like any Nix-based system, some Nix background +knowledge is recommended before installation. + +If you're new to the Nix ecosystem, you may want to check out some [community resources](/resources) +first, to get familiar with how Nix works. + + +## On NixOS + +If you haven't already installed NixOS, do so using any upstream +[install image](https://nixos.org/download/#NixOS) and the instructions in the +[NixOS Manual](https://nixos.org/manual/nixos/stable/#sec-installation). Then, follow +the instructions for either: + +- [flake-based configurations](/add-to-config#flake-based-configurations); or +- [non-flake configurations](/add-to-config#non-flake-configurations) + +depending on how you prefer to configure your system. + + +## On an Existing `nix-darwin` Install + +If you already have a [nix-darwin](https://github.com/LnL7/nix-darwin) installation, you +can use the same instructions as installing on a NixOS-based system. Follow the instructions +for either: + +- [flake-based configurations](/add-to-config#flake-based-configurations); or +- [non-flake configurations](/add-to-config#non-flake-configurations) + +depending on how you prefer to configure your system. + + +## On Any Other Linux/MacOS System + +You can either perform a **new install**, or choose to +**upgrade an existing install** to Lix. + +### New Installs + +The easiest way to install Lix is to use the [Lix Installer](https://git.lix.systems/lix-project/lix-installer)[^1]. +Open a terminal, and run the following command: + +```sh +$ curl -sSf -L https://install.lix.systems/lix | sh -s -- install +``` + +The installer will guide you through installing Lix -- and once it's finished, +you'll have a full, working installation. If you're not sure what to do, now is a +great time to check out some of the [community's resources on Nix](/resources). + +### Existing Installs + +If you have an existing Nix installation, you should be able to upgrade by using a variant +of the `upgrade-nix` command. + + +This section is currently pending on a pull request, so these instructions are for proofreading only. + +
+
+ +**If you have flakes enabled**, the following command should perform an upgrade: + +```sh +$ sudo nix run 'https://git.lix.systems/lix-project/lix' -- upgrade-nix +``` + +**If you don't have flakes enabled**, you can perform a slightly more complex command: + +```sh +$ ***TODO FIXME*** +``` + +You should now have an upgraded version of Nix. You can verify this by asking Lix +to report its version: + +```sh +$ nix --version +nix (Lix, like Nix) 2.90.0-lix +``` + +As long as you see `Lix` in the output, you're good! If you're not sure what to do now, it's a +great time to check out some of the [community's resources on Nix](/resources). + +## Having Trouble? + +If you're having difficulty installing Lix, don't panic! Hop on over to our +[community page](/community), and check out the various ways to find help. + +[^1]: a customized variant of the [Determinant Nix Installer](https://github.com/DeterminateSystems/nix-installer). diff --git a/themes/lix/assets/scss/sections/blog-single.scss b/themes/lix/assets/scss/sections/blog-single.scss index 2bf4b221..d31b2ec2 100644 --- a/themes/lix/assets/scss/sections/blog-single.scss +++ b/themes/lix/assets/scss/sections/blog-single.scss @@ -24,4 +24,9 @@ font-weight: bold; margin-top: 2rem; } + + div.footnotes { + margin-top: 5rem; + filter: opacity(60%); + } }