Skip to content

Commit 7064f82

Browse files
feat: add github pages via typedoc
1 parent 209af01 commit 7064f82

26 files changed

+15851
-32115
lines changed

.github/workflows/publish.yml

+7
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,10 @@ jobs:
2020
- run: npm publish
2121
env:
2222
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
23+
24+
- name: Pages
25+
- run: npm run typedoc
26+
uses: peaceiris/actions-gh-pages@v3
27+
with:
28+
github_token: ${{ secrets.GITHUB_TOKEN }}
29+
publish_dir: ./docs/pages

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ node_modules/
1717
.DS_Store
1818
.vscode/
1919
temp/
20+
21+
docs/pages

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ Some initial docs are [here](https://github.com/IdentityModel/oidc-client-js/wik
3030

3131
Using [npm](https://npmjs.org/)
3232

33-
```console
33+
```sh
3434
$ npm install oidc-client-ts
3535
```
3636

3737

3838
## Building the Source
3939

40-
```console
40+
```sh
4141
$ git clone https://github.com/authts/oidc-client-ts.git
4242
$ cd oidc-client-ts
4343
$ npm install
@@ -48,7 +48,7 @@ $ npm run build
4848

4949
**Parcel project**
5050

51-
```console
51+
```sh
5252
$ npm run -w parcel-sample start
5353
```
5454

@@ -60,7 +60,7 @@ can be found [here](https://github.com/authts/sample-angular-oidc-client-ts).
6060

6161
### Running the Tests
6262

63-
```console
63+
```sh
6464
$ npm test
6565
```
6666

docs/intro.md docs/index.md

-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
sidebar_position: 1
3-
slug: /
4-
---
5-
61
# oidc-client
72
oidc-client is a JavaScript library intended to run in browsers (and possibly Cordova style applications). It provides protocol support for OIDC and OAuth2, as well as management functions for user sessions and access tokens management.
83

0 commit comments

Comments
 (0)