Skip to content

Commit

Permalink
docs: add usage docs page with button
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Feb 4, 2024
1 parent 5b685f2 commit da036dc
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@
</a>
</p>

## [![🚩 Deploy to CDN](https://github.com/hotosm/ui/actions/workflows/cdn_deploy.yml/badge.svg?branch=main)](https://github.com/hotosm/ui/actions/workflows/cdn_deploy.yml)

📖 **Documentation**: <a href="https://hotosm.github.io/ui/" target="_blank">https://hotosm.github.io/ui/</a>

🖥️ **Source Code**: <a href="https://github.com/hotosm/ui" target="_blank">https://github.com/hotosm/ui</a>
Expand Down
19 changes: 19 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Usage

```js
<script src="https://hotosm.github.io/ui/dist/core.js">

<div>
<hot-button disabled="false"> </hot-button>
</div>
```

<!-- markdownlint-disable -->

<script src="https://hotosm.github.io/ui/dist/core.js">

<div>
<hot-button disabled="false"> </hot-button>
</div>

<!-- markdownlint-enable -->
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ nav:
- About: about.md
- Components:
- Button: components/hot-button.md
- Usage: usage.md
- Storybook: storybook.md
- License: LICENSE.md
- Changelog: CHANGELOG.md

0 comments on commit da036dc

Please sign in to comment.