Skip to content

Commit

Permalink
📝 docs (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
techouse authored Apr 29, 2024
1 parent d304167 commit 8e9455c
Show file tree
Hide file tree
Showing 7 changed files with 134 additions and 96 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Docs

on:
workflow_dispatch:
branches:
- main
workflow_call:

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Setup Dart SDK
uses: dart-lang/setup-dart@v1
with:
sdk: stable
- id: checkout
name: Checkout repository
uses: actions/checkout@v4
- id: install
name: Install dependencies
run: dart pub get
- name: Build documentation
run: dart doc .
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/api/
force_orphan: true
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ pubspec.lock

# Coverage
coverage/

# Docs
doc/
Loading

0 comments on commit 8e9455c

Please sign in to comment.