improve documentation (#424)

* chore(deps-dev): pin sveld dependency to v0.3.0

* docs: escape HTML in component prop descriptions

* docs(ordered-list): describe use case for using native styles

#418

* docs: update count for icons, charts packages

* docs(readme): update description, links
This commit is contained in:
Eric Liu 2020-11-27 05:15:24 -08:00 committed by GitHub
commit a53bddf8f6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 30 additions and 13 deletions

View file

@ -25,7 +25,7 @@
<Column>
<h1>Carbon Components Svelte</h1>
<p class="big-paragraph">
carbon-components-svelte is a
Carbon Components Svelte is a
<Link
inline
class="big-link"
@ -44,8 +44,8 @@
by IBM.
</p>
<p>
A design system can facilitate frontend development and prototyping
because it encourages reuse, consistency, and extensibility.
Design systems facilitate design and development through reuse,
consistency, and extensibility.
</p>
</Column>
</Row>
@ -74,8 +74,8 @@
<Column>
<h3>Portfolio</h3>
<p>
The broader Carbon Svelte effort extends to the icons, pictograms, and
data visualization libraries.
The broader Carbon Svelte effort includes libraries for icons,
pictograms, and data visualization.
</p>
</Column>
</Row>
@ -94,7 +94,7 @@
<TileCard
borderBottom
title="Carbon Icons Svelte"
subtitle="5000+ icons"
subtitle="5800+ icons"
target="_blank"
href="https://github.com/IBM/carbon-icons-svelte"
/>
@ -113,7 +113,7 @@
<Column xlg="{5}" lg="{8}" md="{4}">
<TileCard
title="Carbon Charts Svelte"
subtitle="13 chart types, powered by d3"
subtitle="16 chart types, powered by d3"
target="_blank"
href="https://github.com/carbon-design-system/carbon-charts/tree/master/packages/svelte"
/>