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

Show rendered HMTL boxes in documentation #4

Open
TimTeaFan opened this issue Feb 8, 2023 · 1 comment
Open

Show rendered HMTL boxes in documentation #4

TimTeaFan opened this issue Feb 8, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@TimTeaFan
Copy link
Owner

TimTeaFan commented Feb 8, 2023

At the momentan the documentation (README) shows how to implement HTML boxes, but they are not visually displayed. It would be great to actually use the boxes in the documentation, but the default output format of the readme is github_document() and I'm not sure if we can switch it to hugodownplus::md_document(). If that is not possible, we could fake it with direct HTML tags <details> and HTML <summary> or just use a screenshot instead (the latter would be less cool).

@TimTeaFan TimTeaFan self-assigned this Feb 8, 2023
@TimTeaFan TimTeaFan added the documentation Improvements or additions to documentation label Feb 8, 2023
@TimTeaFan
Copy link
Owner Author

It seems actually using hugodownplus::md_document() as output format of the README Rmd is not rendering correctly, see here.

However, we can just fake the boxes (as shown here) but I'm not sure if we can apply preset CSS styles, probably not in the rendered Github README, but we could add CSS to the extra.css file of the {pkgodown} website, then at least there we would have some sort of semi-live demo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant