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

Create a material style theme #1862

Closed
vicancy opened this issue Jul 12, 2017 · 6 comments
Closed

Create a material style theme #1862

vicancy opened this issue Jul 12, 2017 · 6 comments
Assignees
Labels
customization Site customization, custom styles, headers, footers and layouts help-wanted You could start with this if you want to contribute to the project

Comments

@vicancy
Copy link
Contributor

vicancy commented Jul 12, 2017

the layout of Google API theme looks quite similar to docfx's
image

@928PJY 928PJY added the customization Site customization, custom styles, headers, footers and layouts label Aug 11, 2017
@shyamal890
Copy link

+1

@vicancy vicancy added the help-wanted You could start with this if you want to contribute to the project label Dec 12, 2017
@ovasquez
Copy link
Contributor

The Material Theme for MkDocs could be used as the base for the docfx theme
https://squidfunk.github.io/mkdocs-material/

There are already a couple of ports of that theme to other generators:

@JimBobSquarePants
Copy link

Creating a theme here shouldn't be a concern of the core project, rather simplifying the creation of themes should be.

There are serious markup, css styling and accessibility issues with the default templates and I would suggest getting someone with UX/frontend skills involved to help clean it up.

I've noted in an attempt to style the default output:

  • Removal of outline styles.
  • Lack of aria attribution for menu items
  • Over specificity of css selectors
  • Floating items without clearing containers
  • Absolute and fixed positioning where it simply isn't required.
  • Over complication of markup for iconography
  • Tiny clickable areas (side nav)
  • No use of sections/articles.
  • Very limited use of Html5 roles
  • Old JQuery library inclusion

And that's just scratching the surface.

This work would require a major version as it would introduce breaking changes.

I'm more than a little disappointed that MS didn't strive to make the output more inclusive.

@yufeih
Copy link
Contributor

yufeih commented Mar 20, 2018

@JimBobSquarePants,

We know there are lots of areas to improve in docfx and creating a customized theme is just one of the outstanding problems. Like you mentioned, a major breaking change is needed to modernize the system. We had some initial discussions around how to build the next version of docfx and customized themes is definitely a big topic. It is still at the very early stage, but we'd like to hear all food for thoughts.

@JimBobSquarePants
Copy link

Hey @yufeih long time no chat! 😄

When you get around to making plans for vnext more concrete I'd love to help so please let me know.

@superyyrrzz
Copy link
Contributor

#4002

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customization Site customization, custom styles, headers, footers and layouts help-wanted You could start with this if you want to contribute to the project
Projects
None yet
Development

No branches or pull requests

7 participants