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.

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

Jump to bottom

Configure TypeDoc, GitHub Pages for static documentation site generation and deployment #68

Merged
merged 8 commits into from
Dec 20, 2023
Merged

Configure TypeDoc, GitHub Pages for static documentation site generation and deployment #68

merged 8 commits into from
Dec 20, 2023

Conversation

MajorLift
Copy link
Collaborator

@MajorLift MajorLift commented Nov 26, 2023 •
edited
Loading

Explanation

  1. Sets up a TypeDoc configuration that automatically generates a static documentation site based on up-to-date JSDoc comments.
  2. Sets up a GitHub Actions workflow that deploys auto-generated TypeDoc documentation to a GitHub Pages static site.

Screenshots

Example live site deployed from fork: https://majorlift.github.io/hkt-toolbelt/

Dark mode

Screenshot 2023-11-25 at 4 45 46 PM

Light mode

Screenshot 2023-11-25 at 4 46 39 PM

Instructions

  • Further manual configuration is required to deploy from main repo.
  • Set to deploy GitHub Pages from the gh-pages branch.
Screenshot 2023-11-25 at 6 24 25 PM

References

@MajorLift MajorLift force-pushed the 231125-typedoc-workflow branch from 6aac434 to 58e3e7e Compare November 26, 2023 04:03
@MajorLift MajorLift force-pushed the 231125-typedoc-workflow branch from 58e3e7e to 99b9725 Compare November 26, 2023 04:07
@MajorLift MajorLift mentioned this pull request Nov 26, 2023
Merged
@MajorLift MajorLift self-assigned this Nov 26, 2023
@MajorLift MajorLift added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 26, 2023
@MajorLift MajorLift requested a review from poteat November 26, 2023 20:34
@MajorLift MajorLift force-pushed the 231125-typedoc-workflow branch from e5963b0 to 95ce196 Compare November 26, 2023 22:44
@MajorLift MajorLift changed the title Configure TypeDoc documentation generator Configure TypeDoc, GitHub Pages to auto-generate and publish documentation Nov 27, 2023
@MajorLift MajorLift changed the title Configure TypeDoc, GitHub Pages to auto-generate and publish documentation Configure TypeDoc, GitHub Pages for static documentation site generation and deployment Nov 27, 2023
@MajorLift MajorLift mentioned this pull request Nov 27, 2023
Closed
9 tasks
@MajorLift MajorLift merged commit cb60d8c into main Dec 20, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@poteat poteat poteat approved these changes

Assignees

@MajorLift MajorLift

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

What is the state of the main documentation?
2 participants
@MajorLift @poteat