Skip to content

build: add scripts to generate API document into README.md #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

build: add scripts to generate API document into README.md #28

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cb7d42f
build: add scripts to generate API document into README.md
Atry Jan 16, 2023
0edf17e
docs: update comments to mention API docs
Atry Jan 16, 2023
d142d54
docs(readme): regenerate README.md
Atry Jan 16, 2023
5dccfdc
Update package.json
Atry Mar 13, 2025
7e5fb6e
Update src/index.ts
Atry Mar 13, 2025
413e530
Update typedoc.json
Atry Mar 13, 2025
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
5 changes: 4 additions & 1 deletion .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# Set the repository to show as TypeScript rather than JS in GitHub
*.js linguist-detectable=false
*.js linguist-detectable=false

/CHANGELOG.md linguist-generated
/README.md linguist-generated
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,6 @@ dist

# Compiled code
lib/

# TypeDoc
docs/
70 changes: 48 additions & 22 deletions README.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading