Skip to content

Commit dfbbd31

Browse files
authored
chore: create docs with docosaurus (#659)
* 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
1 parent 4b13041 commit dfbbd31

23 files changed

+8916
-1029
lines changed

.github/FUNDING.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
github: [oblador, vonovak]
1+
github: [oblador, vonovak, DorianMazur]

.github/workflows/docs.yaml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
11+
jobs:
12+
build:
13+
name: Build Docusaurus
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
- name: Setup Node.js
20+
uses: actions/setup-node@v4
21+
with:
22+
node-version-file: .nvmrc
23+
- name: Enable corepack
24+
run: corepack enable
25+
- name: Install dependencies
26+
run: yarn install --immutable
27+
- name: Build website
28+
working-directory: ./website
29+
run: yarn build
30+
- name: Upload Build Artifact
31+
if: github.ref_name == 'master'
32+
uses: actions/upload-pages-artifact@v3
33+
with:
34+
path: website/build
35+
36+
deploy:
37+
name: Deploy to GitHub Pages
38+
needs: build
39+
runs-on: ubuntu-latest
40+
if: github.ref_name == 'master'
41+
42+
permissions:
43+
pages: write
44+
id-token: write
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
49+
steps:
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

.gitignore

+6-1
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,9 @@ KeychainExample/e2e/output
9494
KeychainExample/artifacts
9595

9696
# React Native Bob Builder
97-
lib
97+
lib
98+
99+
# Docosaurus
100+
/build
101+
.docusaurus
102+
.cache-loader

README.md

+27-515
Large diffs are not rendered by default.

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
"prepare": "bob build"
2222
},
2323
"workspaces": [
24-
"KeychainExample"
24+
"KeychainExample",
25+
"website"
2526
],
2627
"keywords": [
2728
"react-native",

0 commit comments

Comments
 (0)