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

Separate original pandoc CSS from manubot modified CSS? #156

Closed
vincerubinetti opened this issue Jan 10, 2019 · 7 comments
Closed

Separate original pandoc CSS from manubot modified CSS? #156

vincerubinetti opened this issue Jan 10, 2019 · 7 comments

Comments

@vincerubinetti
Copy link
Collaborator

I'm thinking it may be helpful to separate the two somehow, either by putting our (manubot) CSS overrides at the bottom of github-pandoc.css, or even just in a separate css file. Or maybe in the html file insert I am writing to generate the tooltips, which also contains its own CSS for the tooltips.

Are there any objections to this? Also does someone have a quick summary of the CSS we "slowly modified over time", or would I have to go through the commits.

@slochower
Copy link
Collaborator

No objection, but I'm not sure github-pandoc.css is really "pandoc CSS" in any sense. I think it's really just a CSS file that we pass to pandoc to make the rendered HTML look GitHub-like.

@vincerubinetti
Copy link
Collaborator Author

Yes, sorry, I didn't notice that that stylesheet wasn't authored by pandoc themselves. Regardless, it might be wise to separate our modifications from any third party dependencies. Makes it more clear which party modified which thing, and makes it easier to update the dependencies separately without breaking/forgetting anything.

@dhimmel
Copy link
Member

dhimmel commented Jan 13, 2019

The gist we copied github-pandoc.css from hasn't been updated in years. It was just a file someone posted and doesn't seem to be maintained.

Perhaps we could compare the file to its original version when added to this repo (ignoring whitespace). There haven't been too many changes.

Do you think github-pandoc.css is good or it's something we may want to rewrite from scratch?

@vincerubinetti
Copy link
Collaborator Author

I'll review the css further today, but it seems relatively fine to me. Nothing jumps out at me as bad/dated, in terms of "code quality".

That being said, it doesn't really look exactly like Github, if that's what we're going for. (Maybe it did look like it at the time it was written?). Having 2-3 themes of the most popular/common options, like Github, that PubCSS, etc per #Issue 112 might not actually be a bad idea. I could probably knock them out in 1-2 days per theme.

@dhimmel
Copy link
Member

dhimmel commented Jan 17, 2019

As far as I'm aware, we are not interested in making our manuscripts adhere to the GitHub theme. It seems like the original gist does have this objective. However, I think we just care about making a nice interface to read and interact with articles. When I named the file github-pandoc.css, I think I meant github-pages-pandoc.css. We could consider renaming this file to anything, if that would help remove confusion over its scope and goals.

@vincerubinetti
Copy link
Collaborator Author

Closed due to complete rewrite of CSS theme.

@dhimmel
Copy link
Member

dhimmel commented Jan 29, 2019

See #171 for "complete rewrite of CSS theme"

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