Merge pull request #84 from flox/preview

chore: Release 1.3.5

.flox/env/manifest.lock

@@ -21,6 +21,9 @@
       "lychee": {
         "pkg-path": "lychee"
       },
+      "markdownlint-cli2": {
+        "pkg-path": "markdownlint-cli2"
+      },
       "pandoc": {
         "pkg-path": "pandoc"
       },
@@ -811,6 +814,126 @@
       "group": "toplevel",
       "priority": 5
     },
+    {
+      "attr_path": "markdownlint-cli2",
+      "broken": false,
+      "derivation": "/nix/store/ly73723him9mxrq1c51ac69x3bapj3a6-markdownlint-cli2-0.9.0.drv",
+      "description": "Fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library",
+      "install_id": "markdownlint-cli2",
+      "license": "MIT",
+      "locked_url": "https://github.com/flox/nixpkgs?rev=9f4128e00b0ae8ec65918efeba59db998750ead6",
+      "name": "markdownlint-cli2-0.9.0",
+      "pname": "markdownlint-cli2",
+      "rev": "9f4128e00b0ae8ec65918efeba59db998750ead6",
+      "rev_count": 647193,
+      "rev_date": "2024-07-03T18:27:49Z",
+      "scrape_date": "2024-07-05T00:14:29Z",
+      "stabilities": [
+        "staging",
+        "unstable"
+      ],
+      "unfree": false,
+      "version": "0.9.0",
+      "outputs_to_install": [
+        "out"
+      ],
+      "outputs": {
+        "out": "/nix/store/gq9z5kgjvy0fkb6z34798ixzmr95vzg4-markdownlint-cli2-0.9.0"
+      },
+      "system": "aarch64-darwin",
+      "group": "toplevel",
+      "priority": 5
+    },
+    {
+      "attr_path": "markdownlint-cli2",
+      "broken": false,
+      "derivation": "/nix/store/s0py830wfl7h1h0fl6d4gjcycdgfyf88-markdownlint-cli2-0.9.0.drv",
+      "description": "Fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library",
+      "install_id": "markdownlint-cli2",
+      "license": "MIT",
+      "locked_url": "https://github.com/flox/nixpkgs?rev=9f4128e00b0ae8ec65918efeba59db998750ead6",
+      "name": "markdownlint-cli2-0.9.0",
+      "pname": "markdownlint-cli2",
+      "rev": "9f4128e00b0ae8ec65918efeba59db998750ead6",
+      "rev_count": 647193,
+      "rev_date": "2024-07-03T18:27:49Z",
+      "scrape_date": "2024-07-05T00:14:29Z",
+      "stabilities": [
+        "staging",
+        "unstable"
+      ],
+      "unfree": false,
+      "version": "0.9.0",
+      "outputs_to_install": [
+        "out"
+      ],
+      "outputs": {
+        "out": "/nix/store/3vjb5jnyn7jpcfvmkv2cv4w2api4wn20-markdownlint-cli2-0.9.0"
+      },
+      "system": "aarch64-linux",
+      "group": "toplevel",
+      "priority": 5
+    },
+    {
+      "attr_path": "markdownlint-cli2",
+      "broken": false,
+      "derivation": "/nix/store/siqhdbkdlj22zv4bsb78cnzmvch1m4lb-markdownlint-cli2-0.9.0.drv",
+      "description": "Fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library",
+      "install_id": "markdownlint-cli2",
+      "license": "MIT",
+      "locked_url": "https://github.com/flox/nixpkgs?rev=9f4128e00b0ae8ec65918efeba59db998750ead6",
+      "name": "markdownlint-cli2-0.9.0",
+      "pname": "markdownlint-cli2",
+      "rev": "9f4128e00b0ae8ec65918efeba59db998750ead6",
+      "rev_count": 647193,
+      "rev_date": "2024-07-03T18:27:49Z",
+      "scrape_date": "2024-07-05T00:14:29Z",
+      "stabilities": [
+        "staging",
+        "unstable"
+      ],
+      "unfree": false,
+      "version": "0.9.0",
+      "outputs_to_install": [
+        "out"
+      ],
+      "outputs": {
+        "out": "/nix/store/6aiky5csv516s8iga664kpaa7q7wh6p9-markdownlint-cli2-0.9.0"
+      },
+      "system": "x86_64-darwin",
+      "group": "toplevel",
+      "priority": 5
+    },
+    {
+      "attr_path": "markdownlint-cli2",
+      "broken": false,
+      "derivation": "/nix/store/lid3nxlgcxf7rh63i44pj4avh4ffnabj-markdownlint-cli2-0.9.0.drv",
+      "description": "Fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library",
+      "install_id": "markdownlint-cli2",
+      "license": "MIT",
+      "locked_url": "https://github.com/flox/nixpkgs?rev=9f4128e00b0ae8ec65918efeba59db998750ead6",
+      "name": "markdownlint-cli2-0.9.0",
+      "pname": "markdownlint-cli2",
+      "rev": "9f4128e00b0ae8ec65918efeba59db998750ead6",
+      "rev_count": 647193,
+      "rev_date": "2024-07-03T18:27:49Z",
+      "scrape_date": "2024-07-05T00:14:29Z",
+      "stabilities": [
+        "staging",
+        "unstable"
+      ],
+      "unfree": false,
+      "version": "0.9.0",
+      "outputs_to_install": [
+        "out"
+      ],
+      "outputs": {
+        "out": "/nix/store/12q9lc86ac5i78crmxa0kzq3xc6wsg8k-markdownlint-cli2-0.9.0"
+      },
+      "system": "x86_64-linux",
+      "group": "toplevel",
+      "priority": 5
+    },
     {
       "attr_path": "pandoc",
       "broken": false,

.flox/env/manifest.toml

@@ -19,6 +19,7 @@ python.version = "3.11.*"
 pngquant.pkg-path = "pngquant"
 gnused.pkg-path = "gnused"
 d2.pkg-path = "d2"
+markdownlint-cli2.pkg-path = "markdownlint-cli2"
 
 # Set environment variables in the `[vars]` section. These variables may not
 # reference one another, and are added to the environment without first

.github/workflows/ci.yml

@@ -43,6 +43,11 @@ jobs:
             chmod -R +w ./public/docs
             cp netlify.toml ./public/
 
+      - name: "Check markdown lint"
+        uses: "flox/activate-action@main"
+        with:
+          command: "markdownlint-cli2 docs/**/*.md"
+
       - name: "Check external links"
         uses: "flox/activate-action@main"
         with:

.markdownlint-cli2.yaml

@@ -0,0 +1,15 @@
+config:
+  # Not worth worrying about.
+  code-block-style: false
+  commands-show-output: false
+  line-length: false
+
+  # May not play well with mkdocs processing.
+  no-bare-urls: false
+  reference-links-images: false
+  link-image-reference-definitions: false
+
+  # Take care fixing.
+  fenced-code-language: false
+  no-trailing-punctuation: false
+  single-title: false

FLOX_VERSION

@@ -1 +1 @@
-1.3.4
+1.3.5

docs/concepts/activation.md

@@ -56,6 +56,7 @@ environment rather than from elsewhere on your system.
 We mentioned above that there are three different ways to use an environment.
 
 ### Subshell
+
 We've already mentioned the first method,
 which is to put you into a subshell.
 When you activate this way your existing shell is paused and you're put into a
@@ -80,6 +81,7 @@ shell,
 but in this case it's the original shell.
 
 To make this happen you could do one of these options in Bash:
+
 ```bash
 # Option 1
 source <(flox activate)
@@ -113,11 +115,13 @@ maybe because you have some tools available in your environment that aren't
 available outside the environment.
 
 You could do this in a subshell:
+
 - Enter the subshell via `flox activate`
 - Run the command
 - Exit the subshell via `exit`
 
 You could do a similar thing with an in-place activation:
+
 - Configure your existing shell with `source <(flox activate)`.
 - Run the command
 - Your shell is still configured by Flox when you're done
@@ -128,6 +132,7 @@ shell,
 which you may not want.
 
 The easy way to do this is:
+
 ```bash
 $ flox activate -- <your command>
 ```

docs/concepts/environments.md

@@ -20,7 +20,7 @@ environment.
 
 ## Environment uses
 
-1. **Path environment**: An environment stored in a local directory. 
+1. **Path environment**: An environment stored in a local directory.
     - This environment is self contained in the `.flox` directory and can be
 reproduced by sharing the directory in version control or some other file
 sharing mechanism.
@@ -32,11 +32,11 @@ within a monorepo.
 2. **Centrally managed environment**: An environment stored remotely on
 [FloxHub][floxhub_concept].
 
-     - Centrally managed environments are created by running [`flox push`][flox_push]
-on a path environment. 
+    - Centrally managed environments are created by running [`flox push`][flox_push]
+on a path environment.
      You can connect a new project directory with an existing centrally managed environment with [`flox pull ...`][flox_pull] or you can activate the environment directly with [`flox activate --remote ...`][flox_activate] for instant use.
-     - Centrally managed environments enable multiple projects or systems to consume a
-shared environment that is versioned with [generations][generation_concept].     
+    - Centrally managed environments enable multiple projects or systems to consume a
+shared environment that is versioned with [generations][generation_concept].
 They are commonly used as base environments for projects of similar tech stacks,
 for reproducing issues on specific systems, or to quickly share tools.
     - To disconnect a centrally managed environment from FloxHub, run [`flox pull --copy`][flox_pull] instead of `flox pull`.
@@ -55,13 +55,13 @@ Let's look closer at the files that were generated.
 ### Environment manifest: `.flox/env/manifest.toml`
 
 The manifest is a declarative specification for the environment and contains 5
-parts: 
+parts:
 
-  - **Install:** the packages installed to the environment. 
-  - **Vars:** environment variables for use in the activated environment.
-  - **Hook:** Bash script executed before passing control to the user's shell.
-  - **Profile:** Shell-specific scripts sourced by the user's shell.
-  - **Options:** Environment-scoped options such as supported systems.
+- **Install:** the packages installed to the environment.
+- **Vars:** environment variables for use in the activated environment.
+- **Hook:** Bash script executed before passing control to the user's shell.
+- **Profile:** Shell-specific scripts sourced by the user's shell.
+- **Options:** Environment-scoped options such as supported systems.
 
 **[Read more about the manifest][manifest_concept]** and consult the
 [customizing environments guide][customizing_environments_guide] to walk through

docs/concepts/floxhub.md

@@ -11,7 +11,7 @@ FloxHub is a cloud service that enables you to share your Flox
 ## Account creation in FloxHub
 
 When signing up for a FloxHub account,
-we will **automatically use your GitHub username as the FloxHub account name**. 
+we will **automatically use your GitHub username as the FloxHub account name**.
 
 When you [`flox push`][flox_push] an environment to FloxHub,
 you will be prompted to create an account.
@@ -40,9 +40,9 @@ Once you have found an environment that interests you,
 you can:
 
 * Open the **Environment Details** page for the selected environment by
-**clicking on the environment name**. 
+**clicking on the environment name**.
 * Use the **Share button** to copy CLI sharing commands pre-populated with the
-environment name. 
+environment name.
 * Use the **Delete button** to delete the environment from FloxHub.
 * Use the **Generations shortcut button** to jump into the generations tab of
 the Environment Detail page.
@@ -59,10 +59,10 @@ Below the key facts is a shortcut to the CLI sharing commands.
 * **Current generation tab**: shows you packages that are in your
 [environment's manifest][manifest_concept].
 If your package was installed with a semantic version requirement,
-that information will show on the right side. 
+that information will show on the right side.
 * **Generation tab**: shows you the history of your environment through each
 [generation][generation_concept].
-Each new [`flox push`][flox_push] creates a new generation. 
+Each new [`flox push`][flox_push] creates a new generation.
 * **Change log tab**: describes the updates between each generation.
 Packages that were installed with [`flox install`][flox_install] and uninstalled
 with [`flox uninstall`][flox_uninstall] will be explicitly marked.
@@ -81,7 +81,7 @@ such as those that accept a `--remote` option,
 and some commands such as [`flox pull`][flox_pull] that implicitly refer to
 an environment on FloxHub.
 
-``` console 
+``` console
 $ flox pull example-owner/example-env
 ```
 
@@ -94,7 +94,7 @@ $ flox pull example-owner/example-env
 
 ### Logging out in the CLI
 
-Run the [`flox auth logout`][flox_auth] command. 
+Run the [`flox auth logout`][flox_auth] command.
 
 [flox_website]: https://flox.dev
 [flox_push]: ../reference/command-reference/flox-push.md

docs/concepts/generations.md

@@ -8,7 +8,7 @@ description: Everything you need to know about generations.
 Generations refer to a **version number of an environment** on
 [FloxHub][floxhub_concept].
 Both imperative and declarative commands that modify an environment on
-[FloxHub][floxhub_concept] increment the generation number for the environment. 
+[FloxHub][floxhub_concept] increment the generation number for the environment.
 
 Read more about creating your first generation in the
 [sharing guide][sharing_guide].
@@ -17,7 +17,7 @@ Read more about creating your first generation in the
 
 The first environment generation (1) is created when you use
 **[`flox push`][flox_push]** to send an environment to
-[FloxHub][floxhub_concept]. 
+[FloxHub][floxhub_concept].
 
 ## New generations