Skip to content

Update README.md

Update README.md #39

Workflow file for this run

name: DocFX
on:
push:
branches:
- main
- solution
jobs:
# Build the documentation
build:
runs-on: windows-latest # Required by DocFX
steps:
- name: Checkout
uses: actions/checkout@v2
# with:
# submodules: true
- name: Install DocFX
run: choco install -y docfx
- name: Copy CHANGELOG
run: cp CHANGELOG.md Documentation~/changelog/CHANGELOG.md
- name: Copy LICENSE
run: cp LICENSE.md Documentation~/license/LICENSE.md
- name: Copy Third Party Notices
run: cp "Third Party Notices.md" "Documentation~/license/Third Party Notices.md"
- name: Build
run: docfx Documentation~/docfx.json
# Upload the generated documentation
- name: Upload site artifact
uses: actions/upload-artifact@v1
with:
name: _site
path: _site # Must equals the 'build.dest' value on your docfx.json
# Deploy the generated documentation to the gh-pages branch
deploy:
needs: build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
# with:
# submodules: true
# Download the generated documentation
- name: Download site artifact
uses: actions/download-artifact@v1
with:
name: _site
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
publish_branch: gh-pages
publish_dir: _site