runme: id: 01HPS63DBFZ40KX2WT6H287DAC version: v3

docs.runme.dev

This is the primary documentation website for Runme, located at docs.runme.dev. It primarily serves markdown using Docusaurus 2 to help runme users find installation, configuration, features, intergrations, faq and other information about using or contributing to Runme the open source project (runme.dev).

Check for broken links

$ npm install broken-link-checker -g

Run it against production site.

$ rm -f links.log; npx blc https://docs.runme.dev -ro > links.log
# expected to fail if any non 2xx/3xx status code occur

All 404s.

$ grep "HTTP_404" links.log

Ignore externals.

$ cat links.log | grep -v "https://github.com" | grep -v "https://marketplace" | grep "HTTP_404"

Installation

Install all the dependencies using npm.

npm install

Local Development

When developing locally we remove the build directory to avoid any confusion and run the docusaurus server.

rm -rf build/
npm run start

Most changes are reflected live without having to restart the server.

Build

To build the website locally, or to test/preview the build process that will run in CI.

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Upgrade dependencies

npm i @docusaurus/core@latest @docusaurus/plugin-pwa@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@latest @docusaurus/types@latest

Serve locally

cd build; python3 -m http.server 9000

Deployment

This website is auto-deployed via Vercel's GitHub integration, when your branch is merged into main.

The status can be found here: https://vercel.com/stateful/docs-runme-dev