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

Add CI step to render HTML #2

Open
jbteves opened this issue Feb 8, 2021 · 4 comments
Open

Add CI step to render HTML #2

jbteves opened this issue Feb 8, 2021 · 4 comments

Comments

@jbteves
Copy link
Collaborator

jbteves commented Feb 8, 2021

We should add a CI step to render HTML for convenience.

@notZaki
Copy link

notZaki commented Feb 8, 2021

I think netlify has the ability to create a webpage preview of each PR.
Otherwise, there's htmlpreview, which would look like this for the current PR.

@jbteves
Copy link
Collaborator Author

jbteves commented Feb 8, 2021

htmlpreview looks perfect to me and is a lightweight solution. We could just add it to the README. WDYT @tsalo ?

@notZaki
Copy link

notZaki commented Feb 8, 2021

One potential issue with htmlpreview is that some hyperlinks don't resolve correctly. For example, urls ending with #anchor fail in the current preview.

An alternative is to just write the draft in markdown instead of html. Github will render the markdown. It can then be converted to plain html using pandoc.

@emdupre
Copy link
Member

emdupre commented Feb 9, 2021

I use netlify regularly, and can vouch that it's very dev-friendly :)

But I like your suggestion to convert at the end, @notZaki !

One idea : store markdown in github on main branch, use a github action to convert these to plain html with pandoc and add to a gh-pages branch, which we can render. I do something similar in spirit here: https://github.com/emdupre/nha2020-nilearn/blob/1c9add5f3049a51f34b0284fe0e870b21579f8c9/.github/workflows/book.yml#L32-L42

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

No branches or pull requests

3 participants