From ac1234fc645574d23697f4e2b986dd4c9c41c3ef Mon Sep 17 00:00:00 2001 From: Jeff Dickey <216188+jdx@users.noreply.github.com> Date: Wed, 6 Dec 2023 20:03:08 -0600 Subject: [PATCH] lint --- .markdownlint.json | 6 ++++++ README.md | 26 ++++++++++++++------------ 2 files changed, 20 insertions(+), 12 deletions(-) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000000..213af9b632 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,6 @@ +{ + "MD013": false, + "MD033": false, + "MD040": false, + "MD041": false +} diff --git a/README.md b/README.md index 1fd74f5e47..1c2b3edaa9 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ v20.0.0 - [IDE Integration](#ide-integration) - [Core Plugins](#core-plugins) - [FAQs](#faqs) - - [I don't want to put a `.tool-versions` file into my project since git shows it as an untracked file.](#i-dont-want-to-put-a-tool-versions-file-into-my-project-since-git-shows-it-as-an-untracked-file) + - [I don't want to put a `.tool-versions` file into my project since git shows it as an untracked file](#i-dont-want-to-put-a-tool-versions-file-into-my-project-since-git-shows-it-as-an-untracked-file) - [What is the difference between "nodejs" and "node" (or "golang" and "go")?](#what-is-the-difference-between-nodejs-and-node-or-golang-and-go) - [What does `rtx activate` do?](#what-does-rtx-activate-do) - [`rtx activate` doesn't work in `~/.profile`, `~/.bash_profile`, `~/.zprofile`](#rtx-activate-doesnt-work-in-profile-bash_profile-zprofile) @@ -221,16 +221,18 @@ See [plugins](#plugins) below. ### Common commands - rtx install node@20.0.0 Install a specific version number - rtx install node@20 Install a fuzzy version number - rtx use node@20 Use node-20.x in current project - rtx use -g node@20 Use node-20.x as global default +```text +rtx install node@20.0.0 Install a specific version number +rtx install node@20 Install a fuzzy version number +rtx use node@20 Use node-20.x in current project +rtx use -g node@20 Use node-20.x as global default - rtx install node Install the current version specified in .tool-versions/.rtx.toml - rtx use node@latest Use latest node in current directory - rtx use -g node@system Use system node as global default +rtx install node Install the current version specified in .tool-versions/.rtx.toml +rtx use node@latest Use latest node in current directory +rtx use -g node@system Use system node as global default - rtx x node@20 -- node app.js Run `node app.js` node-20.x on PATH +rtx x node@20 -- node app.js Run `node app.js` node-20.x on PATH +``` ## Installation @@ -1609,7 +1611,7 @@ behavior. ### `rtx activate [OPTIONS] [SHELL_TYPE]` -``` +```text Initializes rtx in the current shell This should go into your shell's rc file. @@ -1650,7 +1652,7 @@ Examples: ### `rtx alias get ` -``` +```text Show an alias for a plugin This is the contents of an alias. entry in ~/.config/rtx/config.toml @@ -1671,7 +1673,7 @@ Examples: ### `rtx alias ls [PLUGIN]` -``` +```text List aliases Shows the aliases that can be specified. These can come from user config or from plugins in `bin/list-aliases`.