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

Add a reference section to each page #10

Open
7 tasks
davestewart opened this issue Sep 28, 2023 · 0 comments
Open
7 tasks

Add a reference section to each page #10

davestewart opened this issue Sep 28, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@davestewart
Copy link
Contributor

Background

Right now, a user has to look through all the examples to know what classes can be added, and the process is generally a copy/paste exercise.

Whilst this is fine to get started, it's not so great for knowing what is available.

Proposal

Add a "Reference" table at either the bottom or top of each page:

Rule Purpose Options
btn Button
btn-$variant Style primary secondary text
btn-$size Size sm lg

Research

Approach:

  • pick a variety of elements and review classes
  • mock up examples in plain markdown

Consider:

  • title
  • num columns
  • column groups
  • config format

Implementation

Config; one of:

Build:

  • Create a Vue component
  • Define a simple config format
  • Test sample configs

Apply:

  • List pages here
@davestewart davestewart added the documentation Improvements or additions to documentation label Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant