From 368f073a2d91b4fc9677436bcec63c6f339b0c93 Mon Sep 17 00:00:00 2001 From: aeneasr Date: Fri, 29 May 2020 18:48:42 +0200 Subject: [PATCH] docs: use mdx for api reference --- docs/docs/reference/{api.md => api.mdx} | 0 docs/docs/sdk/index.md | 2 +- docs/package.json | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/docs/reference/{api.md => api.mdx} (100%) diff --git a/docs/docs/reference/api.md b/docs/docs/reference/api.mdx similarity index 100% rename from docs/docs/reference/api.md rename to docs/docs/reference/api.mdx diff --git a/docs/docs/sdk/index.md b/docs/docs/sdk/index.md index a75ab014e8..30f3fe8d82 100644 --- a/docs/docs/sdk/index.md +++ b/docs/docs/sdk/index.md @@ -11,7 +11,7 @@ promises with regards to the generated SDKs. We hope to improve this process in the future. Before you check out the SDKs, head over to the -[REST API](oathkeeper/sdk/api.md) documentation which includes code samples for +[REST API](oathkeeper/sdk/api.mdx) documentation which includes code samples for common programming languages for each REST endpoint. We publish our SDKs for popular languages in their respective package diff --git a/docs/package.json b/docs/package.json index ffb7a31a9d..8e82cdd254 100644 --- a/docs/package.json +++ b/docs/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "private": true, "scripts": { - "gen": "cd .. && node ./docs/scripts/fix-api.js ./docs/docs/reference/api.md && node ./docs/scripts/config.js docs/config.js", + "gen": "cd .. && node ./docs/scripts/fix-api.js ./docs/docs/reference/api.mdx && node ./docs/scripts/config.js docs/config.js", "docusaurus": "docusaurus", "start": "docusaurus start", "build": "docusaurus build",