From 8d7f67e7c359b3dcf00f183b412004783b7f2afc Mon Sep 17 00:00:00 2001 From: Jari Kolehmainen Date: Wed, 11 Nov 2020 07:57:08 +0200 Subject: [PATCH] downgrade typedoc markdown plugin Signed-off-by: Jari Kolehmainen --- .github/workflows/main.yml | 38 +++++++++++++-------------- docs/extensions/typedoc-readme.md.tpl | 14 +++------- package.json | 2 +- yarn.lock | 9 ++++--- 4 files changed, 27 insertions(+), 36 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fb91a82103..6560efcc11 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -12,17 +12,17 @@ jobs: matrix: node-version: [12.x] steps: - - name: Set up Python 3.7 - uses: actions/setup-python@v2 - with: - python-version: '3.x' + - name: Set up Python 3.7 + uses: actions/setup-python@v2 + with: + python-version: '3.x' - - name: Install dependencies - run: | + - name: Install dependencies + run: | python -m pip install --upgrade pip pip install git+https://${{ secrets.GH_TOKEN }}@github.com/lensapp/mkdocs-material-insiders.git - pip install mkdocs-git-revision-date-localized-plugin mike - + pip install mike + - name: Checkout Release from lens uses: actions/checkout@v2 @@ -30,34 +30,32 @@ jobs: repository: lensapp/lens - name: git config - run: | + run: | git config --local user.email "action@github.com" git config --local user.name "GitHub Action" git pull - + - name: Using Node.js ${{ matrix.node-version }} uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - + - name: Generate Extensions API Reference using typedocs - run: | + run: | yarn install yarn typedocs-extensions-api - for filename in docs/extensions/api/**/*.md; do [ -e "$filename" ] || continue; sed -i '1s/^/---\ntitle: API Reference\n---\n/' $filename; done - - + - name: mkdocs deploy latest - run: | + run: | mike deploy --push latest - + - name: mkdocs deploy new release / tag if: contains(github.ref, 'refs/tags/v') - run: | + run: | mike deploy --push--update-aliases ${{ github.ref }} latest mike set-default --push ${{ github.ref }} - - + + diff --git a/docs/extensions/typedoc-readme.md.tpl b/docs/extensions/typedoc-readme.md.tpl index 9c4b2e799c..f65035951e 100644 --- a/docs/extensions/typedoc-readme.md.tpl +++ b/docs/extensions/typedoc-readme.md.tpl @@ -1,8 +1,6 @@ # Extension API Reference -## Index - -### Modules +## Modules * [App](modules/_core_api_app_.md) * [ClusterFeature](modules/_core_api_cluster_feature_.md) @@ -13,17 +11,11 @@ * [K8sApi](modules/_renderer_api_k8s_api_.md) * [Navigation](modules/_renderer_api_navigation_.md) -### Classes +## Classes * [LensMainExtension](classes/lensmainextension.md) * [LensRendererExtension](classes/lensrendererextension.md) -### Variables - -* [windowManager](README.md#windowmanager) - ## Variables -### windowManager - -• `Let` **windowManager**: WindowManager +* [windowManager](README.md#windowmanager) diff --git a/package.json b/package.json index fdedc38db9..2937f51190 100644 --- a/package.json +++ b/package.json @@ -382,7 +382,7 @@ "ts-node": "^8.10.2", "type-fest": "^0.18.0", "typedoc": "0.17.0-3", - "typedoc-plugin-markdown": "^3.0.11", + "typedoc-plugin-markdown": "^2.4.0", "typeface-roboto": "^0.0.75", "typescript": "^4.0.2", "url-loader": "^4.1.0", diff --git a/yarn.lock b/yarn.lock index efaadd49c6..48b83faa3d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -14202,11 +14202,12 @@ typedoc-default-themes@0.8.0-0: lunr "^2.3.8" underscore "^1.9.1" -typedoc-plugin-markdown@^3.0.11: - version "3.0.11" - resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.0.11.tgz#358c32f4a0086c1dd2da7f56c4b46ade8a63204b" - integrity sha512-/BE/PqnIVbQJ525czM+T3CVaA1gVN9X1Le100z8TV/Lze8LZVkuAUiHRIgw9BKYFm9IQaB88W55k4EV6uUVwYQ== +typedoc-plugin-markdown@^2.4.0: + version "2.4.2" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-2.4.2.tgz#2d83fe4f279643436ebc44ca2f937855b0fd9f12" + integrity sha512-BBH+9/Uq5XbsqfzCDl8Jq4iaLXRMXRuAHZRFarAZX7df8+F3vUjDx/WHWoWqbZ/XUFzduLC2Iuy2qwsJX8SQ7A== dependencies: + fs-extra "^9.0.1" handlebars "^4.7.6" typedoc@0.17.0-3: