Skip to content

Commit

Permalink
fix: build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dabrad26 committed Oct 31, 2023
1 parent d244d48 commit 8a17bcd
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 1 deletion.
Binary file added .DS_Store
Binary file not shown.
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h1 align="center">
</p>

<p>Component and shared patterns for React Native apps using Carbon. Styles are based on the <a href="https://carbondesignsystem.com/designing/design-resources/#native-mobile">Carbon Native Mobile</a> designs. Color (<code>g10</code> for light theme and <code>g100</code> for dark theme) and typography tokens are based on Carbon v11.</p>
<a id="md:documentation" class="tsd-anchor"></a><h2><a href="#md:documentation">Documentation</a></h2><p>Documentation can be found <a>here</a>. This documentation is auto generated by the TypeScript files. To use the documentations you can find each component on the left side as a <code>Class</code>. Each component has a link to the example app code and the Props (<code>Component&lt;ItemProps&gt;</code>) which can be jumped to by clicking the ItemProps. Props will indicate all props this component supports with documentation. Links will jump to related to type declarations.</p>
<a id="md:documentation" class="tsd-anchor"></a><h2><a href="#md:documentation">Documentation</a></h2><p>Documentation can be found <a href="https://carbon-design-system.github.io/carbon-react-native/">here</a>. This documentation is auto generated by the TypeScript files. To use the documentations you can find each component on the left side as a <code>Class</code>. Each component has a link to the example app code and the Props (<code>Component&lt;ItemProps&gt;</code>) which can be jumped to by clicking the ItemProps. Props will indicate all props this component supports with documentation. Links will jump to related to type declarations.</p>
<a id="md:getting-started" class="tsd-anchor"></a><h2><a href="#md:getting-started">Getting started</a></h2><p>To install <code>@carbon/react-native</code> in your project, you will need to run the following
command using <a href="https://www.npmjs.com/">npm</a>:</p>
<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-3">-S</span><span class="hl-1"> </span><span class="hl-2">@carbon/react-native</span>
Expand Down

0 comments on commit 8a17bcd

Please sign in to comment.