Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,19 @@ jobs:
uses: actions/configure-pages@v5
- name: Install dependencies
run: npm install
- name: Run Build Script
# Outputs to the './_site' directory by default
- name: Build API docs
# typedoc outputs to './docs/' (see typedoc.json)
run: npm run docs
- name: Assemble site
# Landing page at the root, typedoc API docs under /api/
run: |
mkdir -p _site/api
cp -R site/. _site/
cp -R docs/. _site/api/
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: "./docs/"
path: "./_site/"

# Deployment job
deploy:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The same edit from a shell, with the bundled `mdpatch` CLI:
echo "Decided: we ship on Thursday." | mdpatch patch append heading "Weekly Sync::Notes" notes.md
```

**API docs:** https://coddingtonbear.github.io/markdown-patch/
**Website:** https://coddingtonbear.github.io/markdown-patch/ · **API docs:** https://coddingtonbear.github.io/markdown-patch/api/

**Contents**

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"bugs": {
"url": "https://github.com/coddingtonbear/markdown-patch/issues"
},
"homepage": "https://github.com/coddingtonbear/markdown-patch#readme",
"homepage": "https://coddingtonbear.github.io/markdown-patch/",
"keywords": [
"markdown",
"patch",
Expand Down
Loading
Loading