diff --git a/.github/workflows/check-markdown.yml b/.github/workflows/check-markdown.yml new file mode 100644 index 000000000..134c8bb7b --- /dev/null +++ b/.github/workflows/check-markdown.yml @@ -0,0 +1,20 @@ +--- +name: Markdown Syntax Validation + +on: [push, workflow_dispatch] + +jobs: + markdown-check: + runs-on: ubuntu-latest + + steps: + - name: Checkout this repository + uses: actions/checkout@v4.0.0 + + - name: Validate Markdown .md + uses: DavidAnson/markdownlint-cli2-action@v12.0.0 + with: + command: config + globs: | + .markdownlint.json + **.md diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 000000000..4a292165f --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,12 @@ +{ + "MD013": false, + "MD024": false, + "MD025": false, + "MD033": false, + "MD049": { + "style": "underscore" + }, + "MD050": { + "style": "asterisk" + } +} \ No newline at end of file diff --git a/README.md b/README.md index 1177b5ab8..b6737dfdb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +
- --- # Kubefirst CLI @@ -46,4 +46,3 @@ Each of our platforms have install guides that detail the prerequesites, command Feed K-Ray a GitHub star ⭐ above to bookmark our project and keep K-Ray happy!! [![Star History Chart](https://api.star-history.com/svg?repos=kubefirst/kubefirst&type=Date)](https://star-history.com/#kubefirst/kubefirst&Date) - diff --git a/build/README.md b/build/README.md index 60ca45868..478ba7587 100644 --- a/build/README.md +++ b/build/README.md @@ -1,8 +1,8 @@ -# Overview +# Overview -Kubefirst cli installation options. +kubefirst CLI installation options. -# Homebrew +## Homebrew ```bash brew install kubefirst/tools/kubefirst @@ -12,31 +12,10 @@ brew install kubefirst/tools/kubefirst kubefirst help ``` -# Linux Download +## Asdf -## Manual Install +> Not maintained by kubefirst -```bash -export KUBEFIRST_VERSION=`curl https://github.com/kubefirst/kubefirst/releases/latest -Ls -o /dev/null -w %{url_effective} | grep -oE "[^/]+$"` -``` - -```bash -export BINARY_URL="https://github.com/kubefirst/kubefirst/releases/download/${KUBEFIRST_VERSION}/kubefirst_${KUBEFIRST_VERSION:1}_linux_amd64.tar.gz" -``` - -```bash -curl -LO $BINARY_URL && \ - tar -xvf kubefirst_${KUBEFIRST_VERSION:1}_linux_amd64.tar.gz -C /usr/local/bin/ && \ - chmod +x /usr/local/bin/kubefirst -``` - -```bash -kubefirst info -``` - -## Install with ASDF ([asdf-kubefirst](https://github.com/Claywd/asdf-kubefirst)) - *Not maintained by kubefirst* - It's best to run latest but if you already have asdf setup and prefer to use it, there is a kubefirst plugin available to get kubefirst installed and running quickly with asdf. Installation instructions for asdf are here. Confirm its installed with `asdf version` @@ -44,11 +23,25 @@ Installation instructions for asdf are here. Confirm its installed with `asdf ve Once you have asdf installed, just run the following commands kubefirst will be up and running. -```zsh -asdf plugin-add kubefirst https://github.com/Claywd/asdf-kubefirst.git; -asdf install kubefirst latest; -asdf global kubefirst; -kubefirst version; +```shell +asdf plugin-add kubefirst https://github.com/Claywd/asdf-kubefirst.git +asdf install kubefirst latest +asdf global kubefirst +kubefirst version ``` +## Linux Manual Installation +```shell +export KUBEFIRST_VERSION=`curl https://github.com/kubefirst/kubefirst/releases/latest -Ls -o /dev/null -w %{url_effective} | grep -oE "[^/]+$"` +``` + +```shell +export BINARY_URL="https://github.com/kubefirst/kubefirst/releases/download/${KUBEFIRST_VERSION}/kubefirst_${KUBEFIRST_VERSION:1}_linux_amd64.tar.gz" +``` + +```shell +curl -LO $BINARY_URL && \ + tar -xvf kubefirst_${KUBEFIRST_VERSION:1}_linux_amd64.tar.gz -C /usr/local/bin/ && \ + chmod +x /usr/local/bin/kubefirst +```