diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..c0c1e1ed --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,11 @@ +{ + "recommendations": [ + "bierner.markdown-preview-github-styles", + "dbaeumer.vscode-eslint", + "eamodio.gitlens", + "EditorConfig.EditorConfig", + "esbenp.prettier-vscode", + "streetsidesoftware.code-spell-checker", + "yzhang.markdown-all-in-one" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json index f4ccc13e..29b465e4 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,5 +2,6 @@ "deno.enable": false, "editor.codeActionsOnSave": { "source.fixAll.eslint": true - } + }, + "markdown.extension.toc.levels": "2..3" } diff --git a/README.md b/README.md index f91ab166..4eb8e111 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,14 @@ Node.js proxying made simple. Configure proxy middleware with ease for [connect] Powered by the popular Nodejitsu [`http-proxy`](https://github.com/nodejitsu/node-http-proxy). [![GitHub stars](https://img.shields.io/github/stars/nodejitsu/node-http-proxy.svg?style=social&label=Star)](https://github.com/nodejitsu/node-http-proxy) -## ⚠️ Note +## ⚠️ Note -This page is showing documentation for version v1.x.x ([release notes](https://github.com/chimurai/http-proxy-middleware/releases)) +This page is showing documentation for version v2.x.x ([release notes](https://github.com/chimurai/http-proxy-middleware/releases)) If you're looking for v0.x documentation. Go to: https://github.com/chimurai/http-proxy-middleware/tree/v0.21.0#readme -## TL;DR +## TL;DR Proxy `/api` requests to `http://www.example.org` @@ -52,9 +52,7 @@ _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#option :bulb: **Tip:** Set the option `changeOrigin` to `true` for [name-based virtual hosted sites](http://en.wikipedia.org/wiki/Virtual_hosting#Name-based). -## Table of Contents - - +## Table of Contents - [Install](#install) - [Core concept](#core-concept) @@ -65,7 +63,7 @@ _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#option - [http-proxy events](#http-proxy-events) - [http-proxy options](#http-proxy-options) - [Shorthand](#shorthand) - - [app.use\(path, proxy\)](#appusepath-proxy) + - [app.use(path, proxy)](#appusepath-proxy) - [WebSocket](#websocket) - [External WebSocket upgrade](#external-websocket-upgrade) - [Intercept and manipulate requests](#intercept-and-manipulate-requests) @@ -77,8 +75,6 @@ _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#option - [Changelog](#changelog) - [License](#license) - - ## Install ```bash