Skip to content

Commit 643bc4a

Browse files
angelo-vangelo-v
authored
Merge pull request SolidOS#337 from solid/publish-api-doc
Publish api doc
2 parents d05380f + 0a37c2f commit 643bc4a

4 files changed

Lines changed: 10 additions & 13 deletions

File tree

‎.travis.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ install:
1010
script:
1111
# This includes build, lint, and jest:
1212
- npm test
13+
- npm run doc
1314
before_deploy:
1415
- node ./travis/bumpversion.js
1516
- sh ./travis/unignore-pages.sh

‎Documentation/developers/publish_README.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,15 @@ document.body.appendChild(aclControlBox)
5252

5353

5454
## Documentation
55+
56+
### API
57+
5558
See https://solid.github.io/solid-ui/Documentation/api/ for the API documentation.
5659

60+
### Components
61+
62+
The UI components are presented in a [storybook](http://solid.github.io/solid-ui/examples/storybook/).
63+
5764
## Overview
5865
This has been a place to put any functionality from solid views which has been generalized to be usable in other views.
5966

‎travis/unignore-pages.sh‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
sed -i 's/lib//' .gitignore
2-
sed -i 's/examples\/storybook//' .gitignore
2+
sed -i 's/examples\/storybook//' .gitignore
3+
sed -i 's/Documentation\/api//' .gitignore

0 commit comments

Comments
 (0)