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

feat:combine documentation deployment changes #82

Closed
wants to merge 3 commits into from

Conversation

Mameta29
Copy link
Collaborator

@Mameta29 Mameta29 commented Dec 4, 2024

  • Create deploy-docs.yml for GitHub Pages deployment
  • Add error display in documentation generation workflow
  • Update deploy-docs.yml with improved configuration
  • Create index.html for proper deployment
  • Implement two ways to generate docs (HTML and Markdown)

🎨 Overview

As the title suggests, modified the documentation generation to output both HTML (for GitHub Pages) and Markdown (for GitHub) formats.

🌈 Details

  • Configure to generate Markdown documentation under /docs/core - for GitHub repository viewing
  • Configure to generate HTML documentation under /docs/core-html - for GitHub Pages hosting
  • Update TypeDoc configurations:
  • Remove plugin setting from root typedoc.json, keeping only essential configs
  • Add docs:md and docs:html scripts to packages/core
  • Set HTML documentation output directory to core-html
  • Add docs/core-html to .prettierignore to exclude from formatting checks

📚 References

This change enables proper generation and management of both Markdown documentation for GitHub viewing and HTML documentation for GitHub Pages.

- Create deploy-docs.yml for GitHub Pages deployment
- Add error display in documentation generation workflow
- Update deploy-docs.yml with improved configuration
- Create index.html for proper deployment
- Implement two ways to generate docs (HTML and Markdown)
@Mameta29 Mameta29 self-assigned this Dec 4, 2024
@Mameta29 Mameta29 marked this pull request as draft December 5, 2024 00:55
@Mameta29 Mameta29 closed this Dec 5, 2024
@Mameta29 Mameta29 deleted the feature/combine-doc-changes branch December 13, 2024 04:32
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.

1 participant