feat(docs): support list in pretty markdown to showcase API's better (closes #900) #1073
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 themFor this we are going to use the
+
list syntax ofmarkdown
to replace with amat-list
e.g.
Also we can use sublists to add more information to a single item leveraging
matLine
e.g.
plus added example in chips README.md
What's included?
Test Steps
npm run serve
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
closes #900