Skip to content

Commit

Permalink
chore: create docs with docosaurus (#659)
Browse files Browse the repository at this point in the history
* chore: create docs with docosaurus

* ci: update docs workflow

* chore: remove api folder in docs folder

* chore: update avatar sizes in readme

* chore: improve typedoc

* chore: remove tt.tsx
  • Loading branch information
DorianMazur authored Oct 2, 2024
1 parent 4b13041 commit dfbbd31
Show file tree
Hide file tree
Showing 23 changed files with 8,916 additions and 1,029 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: [oblador, vonovak]
github: [oblador, vonovak, DorianMazur]
52 changes: 52 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Docs

on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
- name: Enable corepack
run: corepack enable
- name: Install dependencies
run: yarn install --immutable
- name: Build website
working-directory: ./website
run: yarn build
- name: Upload Build Artifact
if: github.ref_name == 'master'
uses: actions/upload-pages-artifact@v3
with:
path: website/build

deploy:
name: Deploy to GitHub Pages
needs: build
runs-on: ubuntu-latest
if: github.ref_name == 'master'

permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,9 @@ KeychainExample/e2e/output
KeychainExample/artifacts

# React Native Bob Builder
lib
lib

# Docosaurus
/build
.docusaurus
.cache-loader
542 changes: 27 additions & 515 deletions README.md

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"prepare": "bob build"
},
"workspaces": [
"KeychainExample"
"KeychainExample",
"website"
],
"keywords": [
"react-native",
Expand Down
Loading

0 comments on commit dfbbd31

Please sign in to comment.