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

Copy non-standard style and JS DOM nodes from the generated docs for richer docs #197

Merged
merged 1 commit into from Mar 26, 2018

Conversation

grahamc
Copy link
Member

@grahamc grahamc commented Mar 26, 2018

I'm working on making the docs a bit nicer. One thing I have done is replaced the .gif's with .svg's: NixOS/nixpkgs#37881 This worked nicely, but because the CSS is completely replaced on deploy to the website, the images break down (see my first comment.)

The simple fix for that is send a PR here adding those six lines to the global CSS, but a more flexible option is allowing some CSS to be carried over from the generated HTML in to the bootstrapified HTML.

I chose this option, though, because a follow-up PR is adding syntax highlighting of our Nix code to the docs. This will also require custom CSS, and a bit of javascript. It seems nice for the nix-build version to have the highlighting, so I'm wary of duplicating the logic in both places ... thus this solution.

This PR, combined with my SVG PR, combined with my syntax highlighting branch come together to look like this:

image

@grahamc grahamc changed the title Copy non-standard styles from the generated docs + JS for richer docs Copy non-standard style and JS DOM nodes from the generated docs + JS for richer docs Mar 26, 2018
@grahamc grahamc changed the title Copy non-standard style and JS DOM nodes from the generated docs + JS for richer docs Copy non-standard style and JS DOM nodes from the generated docs for richer docs Mar 26, 2018
@edolstra edolstra merged commit 4584abb into NixOS:master Mar 26, 2018
@grahamc grahamc deleted the rich-docs branch March 26, 2018 19:24
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.

None yet

2 participants