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

Bootstrap for styling #626

Closed
5 of 7 tasks
haampie opened this issue Jan 18, 2018 · 3 comments · Fixed by #1043
Closed
5 of 7 tasks

Bootstrap for styling #626

haampie opened this issue Jan 18, 2018 · 3 comments · Fixed by #1043

Comments

@haampie
Copy link

haampie commented Jan 18, 2018

See also #615, it proves useful to have some basic Bootstrap styling when adding new features to the HTML part of Documenter.jl.

I've created a new repo (https://github.com/haampie/JuliaDocsAssets) with just some HTML and CSS, preliminary example here: https://haampie.github.io/JuliaDocsAssets/

There's some tooling involved, currently via node/npm packages (brunch and sass-brunch). Maybe it's therefore best to keep the assets in a separate repo? If someone wants to theme things, then it's possible to clone that repo, change the bootstrap variables, generate the CSS, and add the minified CSS to their own repo.

Features & todo:

  • Linkable paragraphs (useful for sharing and in search; immediately jump to the right paragraph) with pure CSS highlight animation (e.g. https://haampie.github.io/JuliaDocsAssets/#p6)
  • Modern CSS (flexbox for the layout & position: sticky for sidebars)
  • SVG logo rather than PNG.
  • Math via KaTeX
  • Code highlighting
  • Mobile version
  • Search field
@mortenpi
Copy link
Member

Thanks for doing this! A couple quick thoughts that came to mind:

  • 👍 to having the tools in a separate repository. We would just PR the relevant CSS/JS files into Documenter when there are updates to the style, right? And it will be great if the users can use that repo to build their own themes as well.

  • I feel that it might be best to replicate the existing style more or less exactly on the first iteration. This is not to say that the style couldn't / shouldn't be improved, but it might be a good idea to separate the more subjective/bikeshed-prone part into a follow-up PR.

  • KaTeX is indeed nicer than MathJax in many ways, but isn't it missing some features/commands?

@KristofferC
Copy link
Member

Any updates on this @haampie. I really like the example so far. It would be cool to get this in as an experimental mode perhaps.

@haampie
Copy link
Author

haampie commented Feb 23, 2018

Hey, I will get back at it soon!

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

Successfully merging a pull request may close this issue.

3 participants