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(docs): support list in pretty markdown to showcase API's better (closes #900) #1073

Merged
merged 1 commit into from
Jan 6, 2018

Conversation

emoralesb05
Copy link
Contributor

@emoralesb05 emoralesb05 commented Jan 5, 2018

Since data-tables arent really responsive, we want to be able to showcase a list for our API properties and events. This means our internal pretty markdown module has to support them

For this we are going to use the + list syntax of markdown to replace with a mat-list

e.g.

+ item 1
+ item 2

Also we can use sublists to add more information to a single item leveraging matLine

e.g.

+ line 1
  + subline 1
  + subline 2
+ sline 2

plus added example in chips README.md

What's included?

  • Support for lists in pretty markdown component
  • Replaces data-table in chips with list

Test Steps

  • npm run serve
  • Go to chips demo
  • See list being rendered

General Tests for Every PR

  • npm run serve:prod still works.
  • npm run tslint passes.
  • npm run stylelint passes.
  • npm test passes and code coverage is not lower.
  • npm run build:release still works.
Screenshots or link to StackBlitz/Plunker

image

closes #900

@emoralesb05 emoralesb05 added this to the Release Candidate 3 milestone Jan 5, 2018
@emoralesb05 emoralesb05 changed the title feat(docs): support list in pretty markdown to showcase API's better feat(docs): support list in pretty markdown to showcase API's better (closes #900) Jan 5, 2018
@emoralesb05 emoralesb05 merged commit ac260e3 into develop Jan 6, 2018
@emoralesb05 emoralesb05 deleted the feature/cfm-list-support branch January 6, 2018 03:53
kriswinbush pushed a commit to kriswinbush/covalent that referenced this pull request Feb 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: represent lists with pretty markdown to show API tables better
1 participant