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

"Header only" option #12

Open
hoffm386 opened this issue Sep 20, 2021 · 1 comment · May be fixed by #16
Open

"Header only" option #12

hoffm386 opened this issue Sep 20, 2021 · 1 comment · May be fixed by #16
Labels
enhancement New feature or request

Comments

@hoffm386
Copy link
Contributor

For the DS curriculum, we often avoid adding the actual README as HTML in Canvas

Instead, we just add the <header> part and leave the rest of the assignment description blank, then also set up a link to our cloud IDE (IllumiDesk) by setting the submission type to "External Tool"

My proposal is to add a flag --header-only (although the actual flag name is flexible) that creates a page with the appropriate title and <header> and leaves off everything else

Creating just the header is really just string interpolation so I wasn't sure how best to incorporate this into the overall gem flow. In my fork I have a "hack" version that still creates the entire README as HTML, then throws that away to just include the header. That doesn't seem ideal for overhauling an entire course, but more structural reorganization seemed more likely to break something

@hoffm386 hoffm386 added the enhancement New feature or request label Sep 20, 2021
@hoffm386
Copy link
Contributor Author

Clarifying further, this thing I call the "header" (based on the HTML element used) is also called the --fis-links or -l option in the current documentation

@ihollander ihollander linked a pull request Nov 2, 2021 that will close this issue
@ihollander ihollander linked a pull request Nov 2, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant