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

Migrate documentation to Laika (sbt-typelevel-site) #17

Merged
merged 6 commits into from
Mar 22, 2024

Conversation

CJSmith-0141
Copy link
Contributor

@CJSmith-0141 CJSmith-0141 commented Mar 16, 2024

addresses #14

edit: Adding some screenshots

Landing page
Screenshot 2024-03-22 at 11 32 46 AM

Sample report
Screenshot 2024-03-22 at 11 47 56 AM

Another sample report
Screenshot 2024-03-22 at 11 51 57 AM

Expectations page
127 0 0 1_4242_features_expectations html

- sbt-scalafix
- sbt-scalajs
- sbt-mdoc
@CJSmith-0141
Copy link
Contributor Author

CJSmith-0141 commented Mar 16, 2024

going to re open this and be more careful with my force push in the future.

@CJSmith-0141 CJSmith-0141 reopened this Mar 16, 2024
}
</style>
<body>
```scala mdoc:passthrough
Copy link
Collaborator

Choose a reason for hiding this comment

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

I take it this is where you've struggled ? Is Laika somehow able to run this snippet via a call to mdoc ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When this passthrough is in a markdown document, Laika hangs. Mdoc doesn't have an issue. By moving it to an html document laika ignores the file.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Mmm that's not ideal :/ , the point of this mdoc invocation is to exemplify the output of the framework. Not that it's critical to the docs but it's kinda nice to have.

Probs worth pinging some of the laïka maintainers for advice ?

Copy link
Contributor Author

@CJSmith-0141 CJSmith-0141 Mar 22, 2024

Choose a reason for hiding this comment

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

This was a problem with the ansi to html transformation making invalid html, fixed by making the html output just dealing with color, instead of trying to get the order of transitions correct in all cases.

see 8b1bca7

Copy link
Collaborator

Choose a reason for hiding this comment

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

@CJSmith-0141, would you mind just uploading a screenshot of the microsite on the PR description ?

@CJSmith-0141 CJSmith-0141 requested a review from Baccata March 22, 2024 14:50
@CJSmith-0141
Copy link
Contributor Author

Some screenshots

Landing page

Screenshot 2024-03-22 at 11 32 46 AM

Expectations page
Screenshot 2024-03-22 at 11 33 19 AM

Install page
Screenshot 2024-03-22 at 11 34 31 AM

Tracing failures (with report)
Screenshot 2024-03-22 at 11 38 05 AM

@Baccata Baccata merged commit a1e39c4 into typelevel:main Mar 22, 2024
12 checks passed
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.

2 participants