Skip to content

Commit

Permalink
feat: add github pages via typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
PascalLuginbuehl committed Nov 3, 2021
1 parent 209af01 commit 7064f82
Show file tree
Hide file tree
Showing 26 changed files with 15,851 additions and 32,115 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,10 @@ jobs:
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

- name: Pages
- run: npm run typedoc
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/pages
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@ node_modules/
.DS_Store
.vscode/
temp/

docs/pages
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ Some initial docs are [here](https://github.com/IdentityModel/oidc-client-js/wik

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

```console
```sh
$ npm install oidc-client-ts
```


## Building the Source

```console
```sh
$ git clone https://github.com/authts/oidc-client-ts.git
$ cd oidc-client-ts
$ npm install
Expand All @@ -48,7 +48,7 @@ $ npm run build

**Parcel project**

```console
```sh
$ npm run -w parcel-sample start
```

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

### Running the Tests

```console
```sh
$ npm test
```

Expand Down
5 changes: 0 additions & 5 deletions docs/intro.md → docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
sidebar_position: 1
slug: /
---

# oidc-client
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.

Expand Down
Loading

0 comments on commit 7064f82

Please sign in to comment.