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

docs: Generate docs using templ #401

Closed
wants to merge 21 commits into from
Closed

docs: Generate docs using templ #401

wants to merge 21 commits into from

Conversation

cugu
Copy link
Contributor

@cugu cugu commented Jan 6, 2024

Adding a simple temple based static side generator the generate the docs.

TODO

  • Fix admonitions
  • Dark mode for code samples

Generated docs: https://cugu.github.io/templ/new/

Fixes #153

@cugu cugu mentioned this pull request Jan 6, 2024
@cugu cugu changed the title Generate docs using templ docs: Generate docs using templ Jan 7, 2024
Comment on lines +4 to +6
push:
branches:
- main
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: Remove before merge

const (
outputPath = "public"
contentPath = "../docs"
defaultBaseURL = "https://cugu.github.io/templ/new/"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: Change before merge

@joerdav
Copy link
Collaborator

joerdav commented Jan 8, 2024

Just a note on this. I'm not sure docgen requires it's own go.mod, I think in most cases 1 go.mod per repo is standard.

@cugu cugu marked this pull request as ready for review January 10, 2024 06:52
@joerdav
Copy link
Collaborator

joerdav commented Jan 16, 2024

Looks good to me! @a-h ?

@cugu cugu closed this May 4, 2024
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.

docs: Rebuilding the Docs
2 participants