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

feat: Use semantic HTML in default theme #1154

Closed
HerrBertling opened this issue Jan 2, 2019 · 2 comments · Fixed by #1156
Closed

feat: Use semantic HTML in default theme #1154

HerrBertling opened this issue Jan 2, 2019 · 2 comments · Fixed by #1156

Comments

@HerrBertling
Copy link
Contributor

HerrBertling commented Jan 2, 2019

Feature request

I'd like to improve the default theme by using some semantic HTML tags in favor of divs throughout the default theme.

What problem does this feature solve?

This would make the default vuepress theme (and thus quite some documentation pages) a bit more accessible.

What does the proposed API look like?

It's not really an API, I just found some places in the theme that could use main, aside or footer instead of a simple div. For example:

I'm not sure whether I'd touch the navbar navigation parts. I'd prefer lis instead of a div per .nav-item, but I'm aware that this change would require way more cross-device/env testing than the "simple quick wins" by exchanging some tags.

How should this be implemented in your opinion?

I'd open a pull request if this is something of interest?

Are you willing to work on this yourself?**

See above :)

By the way: I thought about this some time ago and this article reminded me of that, so I figured I'd ask :)

@yyx990803
Copy link
Member

Sounds good for a PR!

@HerrBertling
Copy link
Contributor Author

Pull request opened 😊

HerrBertling added a commit to HerrBertling/vuepress that referenced this issue Jan 3, 2019
ulivz pushed a commit that referenced this issue Jan 8, 2019
By replacing some `div`s with `header`/`main`/`aside` tags
and adding an aria landmark to the search
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 a pull request may close this issue.

2 participants