diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 88ab7dbf8..095655a8f 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -5,39 +5,35 @@ on:
- master
schedule:
- cron: "0 12 * * *"
+ workflow_dispatch:
jobs:
publish-site:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- - name: Fix remote
- run: git remote set-url origin git@github.com:TypeStrong/typedoc-site.git
- name: Set up Node
uses: actions/setup-node@v1
with:
node-version: "16"
- name: Install
run: npm ci
- - name: Set up auth
- run: |
- git config --global user.email "typedoc@gerritbirkeland.com"
- git config --global user.name "TypeDoc Bot"
- mkdir -p ~/.ssh
- echo "${{ secrets.BOT_SSH_KEY }}" > ~/.ssh/id_rsa
- chmod 0600 ~/.ssh/id_rsa
- ssh-keygen -l -f ~/.ssh/id_rsa
- name: Rebuild /api
run: |
- test -f typedoc || git clone git@github.com:TypeStrong/typedoc.git
+ git clone https://github.com/TypeStrong/typedoc.git
cd typedoc
- git pull
git checkout $(git describe --tags --abbrev=0)
npm ci
node scripts/set_strict.js false
npm run build
node bin/typedoc --options ../typedoc.json --gitRevision $(git describe --tags --abbrev=0)
cd ..
+ - name: Rebuild /example
+ run: |
+ cd typedoc/example
+ npm ci
+ node ../bin/typedoc --options ../../example.typedoc.json --gitRevision $(git describe --tags --abbrev=0)
+ cd ../..
- name: Rebuild schema.json
run: node typedoc/scripts/generate_options_schema.js _site/schema.json
- name: Rebuild markdown site
diff --git a/.gitignore b/.gitignore
index 5826a3c14..eeb332f39 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,7 @@
_site
typedoc
node_modules
-changelog.md
+guides/changelog.md
plugins.json
versions.json
plugin_content.txt
diff --git a/README.md b/README.md
index e87e58847..33957387a 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ menuOrder: 1
```bash
npm i
-npm run build -- --serve
+npm run serve
```
To regenerate the `_site/api/` folder, go to the root directory of
@@ -37,7 +37,16 @@ npm run build
node bin/typedoc --options ../typedoc.json
```
-If new options have been added since the last update, run the following to update the typedoc.json schema:
+To regenerate the `_site/example/` folder:
+
+```bash
+cd typedoc/example
+npm i
+node ../bin/typedoc --options ../../example.typedoc.json
+```
+
+If new options have been added since the last update, run the following to
+update the typedoc.json schema:
```bash
node typedoc/scripts/generate_options_schema.js _site/schema.json
diff --git a/_includes/header.html b/_includes/header.html
index 7d0f09800..a42c74efb 100644
--- a/_includes/header.html
+++ b/_includes/header.html
@@ -3,9 +3,9 @@
TypeDoc