Skip to content

Commit

Permalink
feat: added near-sdk-js typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Matias Benary committed Nov 29, 2023
1 parent c1f51d2 commit 8e55331
Show file tree
Hide file tree
Showing 5 changed files with 1,019 additions and 672 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/typedoc-generator.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Deploy TypeDoc on GitHub pages

on:
push:
branches:
develop

env:
NODE_VERSION: 18.x
ENTRY_FILE: 'packages'
CONFIG_PATH: 'tsconfig.base.json'
USES_PNPM: 'true'

jobs:
deploy:
concurrency: ci-${{ github.ref }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v3
with:
node-version: ${{ env.NODE_VERSION }}

- name: Setup pnpm
uses: pnpm/[email protected]
with:
version: 7

- name: Install dependencies
run: pnpm install --no-frozen-lockfile

- name: Build project
run: pnpm build

- name: Build documentation
run: pnpm docs:generate

- name: Deploy to GitHub pages
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs
clean: true
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@
"build": "turbo run build",
"test": "turbo run test",
"lint": "turbo run lint",
"format": "turbo run format"
"format": "turbo run format",
"docs:generate": "typedoc"
},
"devDependencies": {
"turbo": "^1.4.5"
"turbo": "^1.4.5",
"typedoc": "^0.25.3",
"typescript": "5.2.x"
}
}
9 changes: 9 additions & 0 deletions packages/near-sdk-js/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"extends": [
"../../typedoc.json"
],
"entryPoints": [
"src"
],
"entryPointStrategy": "expand",
}
Loading

0 comments on commit 8e55331

Please sign in to comment.