Skip to content
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.

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

Install TypeDoc and deploy TypeDoc documentation site #15

Merged
merged 5 commits into from
Sep 4, 2023

Conversation

lolmaus
Copy link
Contributor

@lolmaus lolmaus commented Aug 15, 2023

⚠️ This PR contains commits from #14. It will clear up once #14 is merged.

This PR contains the follwing changes:

  • Install TypeDoc.
  • Add CI workflow to deploy a TypeDoc static website to GitHub Pages from the main branch.
  • Add watch, serve and dev scripts to package.json. dev runs watch and serve together.
  • Add *.log to .gitignore (mostly unrelated to the PR, protects against Yarn's habit of 💩 into the codebase).
  • Add ESLint and eslint-plugin-tsdoc. This includes a lint step to the default CI routine.

@mansona mansona changed the title Install TypeDoc Install TypeDoc and deploy TypeDoc documentation site Sep 4, 2023
@mansona mansona added the enhancement New feature or request label Sep 4, 2023
Copy link
Member

@mansona mansona left a comment

Choose a reason for hiding this comment

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

Looks good 🎉

@mansona mansona merged commit 95b45c0 into embroider-build:main Sep 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants