Skip to content

Commit

Permalink
Merge pull request #1864 from timdeschryver/docs-update-docusaurus
Browse files Browse the repository at this point in the history
infra: update docs to docusaurus v3
  • Loading branch information
FabianGosebrink authored Nov 14, 2023
2 parents 2f1e874 + 5adaf4c commit d9d48f3
Show file tree
Hide file tree
Showing 7 changed files with 26,291 additions and 20,003 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v1
with:
node-version: 16.16.0
node-version: 18

- name: Installing Dependencies
run: sudo npm install
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This library is <a href="http://openid.net/certification/#RPs">certified</a> by

You can use the schematics and `ng add` the library.

```
```shell
ng add angular-auth-oidc-client
```

Expand Down
14 changes: 4 additions & 10 deletions docs/site/angular-auth-oidc-client/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,18 @@ You can either use the schematics with `ng add` or install the lib and add the n

You can use the schematics and `ng add` the library.

```
```bash
ng add angular-auth-oidc-client
```

Step through the wizard and select the appropriate configuration options for you environment. Once the wizard is complete, a module will be created to encapsulate your OIDC configuration. Many of the configured values are placeholders and will need to be adjusted for your individual use case. Once you've confirmed your configuration, the library is ready to use.

### Npm / Yarn
### Npm / Yarn / pnpm

Navigate to the level of your `package.json` and type

```ts
npm install angular-auth-oidc-client
```

or with yarn

```ts
yarn add angular-auth-oidc-client
```bash npm2yarn
npm install angular-auth-oidc-client
```

After installing the library you can get started with the lib like below.
Expand Down
13 changes: 11 additions & 2 deletions docs/site/angular-auth-oidc-client/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ module.exports = {
favicon: 'img/favicon.ico',
organizationName: 'damienbod', // Usually your GitHub org/user name.
projectName: 'Angular Auth OIDC Client', // Usually your repo name.
markdown: {
format: 'md',
},
themeConfig: {
navbar: {
title: 'Angular Auth OIDC Client Docs',
Expand Down Expand Up @@ -71,7 +74,7 @@ module.exports = {
copyright: `Copyright © ${new Date().getFullYear()} Angular Auth OIDC Client Docs, Inc. Built with Docusaurus.`,
},
prism: {
additionalLanguages: ['typescript'],
additionalLanguages: ['typescript', 'bash', 'json'],
},
},
presets: [
Expand All @@ -81,7 +84,13 @@ module.exports = {
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl: 'https://github.com/damienbod/angular-auth-oidc-client',
editUrl:
'https://github.com/damienbod/angular-auth-oidc-client/edit/main/docs/site/angular-auth-oidc-client',
remarkPlugins: [
[require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }],
],
showLastUpdateAuthor: true,
showLastUpdateTime: true,
},
blog: {
showReadingTime: true,
Expand Down
Loading

0 comments on commit d9d48f3

Please sign in to comment.