Skip to content

Conversation

@mhmd-azeez
Copy link
Collaborator

@mhmd-azeez mhmd-azeez commented Nov 15, 2023

  • install typedoc with github theme
  • add github actions to automatically deploy to GitHub pages when a new tag is created
  • also merged main into gh-pages to make sure we won't have any merge confclits

Fixes #16
Related #13

@mhmd-azeez mhmd-azeez requested a review from wikiwong November 15, 2023 14:23
Copy link
Contributor

@chrisdickinson chrisdickinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thank you! I left one suggestion but otherwise LGTM!

token: ${{ secrets.NPM_TOKEN }}

- name: typedoc
run: npx typedoc .\src\mod.ts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
run: npx typedoc .\src\mod.ts
run: just docs

@chrisdickinson chrisdickinson merged commit 8e4fc5a into main Nov 15, 2023
@chrisdickinson chrisdickinson deleted the docs/typedoc branch November 15, 2023 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Setup documentation website

2 participants