Skip to content

Commit ff85b78

Browse files
krizzukrizzu
committed
docs: basic website setup
1 parent 973f283 commit ff85b78

File tree

9 files changed

+217
-1
lines changed

9 files changed

+217
-1
lines changed

‎.github/requirements.in‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mike==2.1.3
2+
mkdocs==1.6.1
3+
mkdocs-material==9.6.20

‎.github/requirements.txt‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
#
2+
# This file is autogenerated by pip-compile with Python 3.11
3+
# by the following command:
4+
#
5+
# pip-compile
6+
#
7+
babel==2.17.0
8+
# via mkdocs-material
9+
backrefs==5.9
10+
# via mkdocs-material
11+
certifi==2025.8.3
12+
# via requests
13+
charset-normalizer==3.4.3
14+
# via requests
15+
click==8.2.1
16+
# via
17+
# mkdocs
18+
# mkdocs-material
19+
colorama==0.4.6
20+
# via mkdocs-material
21+
ghp-import==2.1.0
22+
# via mkdocs
23+
idna==3.10
24+
# via requests
25+
importlib-metadata==8.7.0
26+
# via mike
27+
importlib-resources==6.5.2
28+
# via mike
29+
jinja2==3.1.6
30+
# via
31+
# mike
32+
# mkdocs
33+
# mkdocs-material
34+
markdown==3.9
35+
# via
36+
# mkdocs
37+
# mkdocs-material
38+
# pymdown-extensions
39+
markupsafe==3.0.2
40+
# via
41+
# jinja2
42+
# mkdocs
43+
mergedeep==1.3.4
44+
# via
45+
# mkdocs
46+
# mkdocs-get-deps
47+
mike==2.1.3
48+
# via -r requirements.in
49+
mkdocs==1.6.1
50+
# via
51+
# -r requirements.in
52+
# mike
53+
# mkdocs-material
54+
mkdocs-get-deps==0.2.0
55+
# via mkdocs
56+
mkdocs-material==9.6.20
57+
# via -r requirements.in
58+
mkdocs-material-extensions==1.3.1
59+
# via mkdocs-material
60+
packaging==25.0
61+
# via mkdocs
62+
paginate==0.5.7
63+
# via mkdocs-material
64+
pathspec==0.12.1
65+
# via mkdocs
66+
platformdirs==4.4.0
67+
# via mkdocs-get-deps
68+
pygments==2.19.2
69+
# via mkdocs-material
70+
pymdown-extensions==10.16.1
71+
# via mkdocs-material
72+
pyparsing==3.2.5
73+
# via mike
74+
python-dateutil==2.9.0.post0
75+
# via ghp-import
76+
pyyaml==6.0.3
77+
# via
78+
# mike
79+
# mkdocs
80+
# mkdocs-get-deps
81+
# pymdown-extensions
82+
# pyyaml-env-tag
83+
pyyaml-env-tag==1.1
84+
# via
85+
# mike
86+
# mkdocs
87+
requests==2.32.5
88+
# via mkdocs-material
89+
six==1.17.0
90+
# via python-dateutil
91+
urllib3==2.5.0
92+
# via requests
93+
verspec==0.1.0
94+
# via mike
95+
watchdog==6.0.0
96+
# via mkdocs
97+
zipp==3.23.0
98+
# via importlib-metadata

‎.github/workflows/deploy-docs.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy docs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
paths:
7+
- 'docs/**'
8+
- 'mkdocs.yml'
9+
- 'CHANGELOG.md'
10+
workflow_dispatch:
11+
jobs:
12+
deploy-docs:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v5
16+
with:
17+
token: ${{ secrets.GH_BOT_TOKEN }}
18+
- uses: actions/setup-python@v6
19+
with:
20+
python-version: 3.11
21+
- name: Install MkDocs
22+
run: pip install --no-deps -r .github/requirements.txt
23+
- name: Copy changelog
24+
run: |
25+
cp packages/async-storage/CHANGELOG.md docs/changelog.md
26+
- name: Setup git user
27+
run: ./setup-ci-git-user.sh
28+
working-directory: ./.github/scripts
29+
env:
30+
GITHUB_TOKEN: ${{ secrets.GH_RELEASE_TOKEN }}
31+
GITHUB_NAME: ${{ vars.GH_BOT_NAME }}
32+
GITHUB_EMAIL: ${{ vars.GH_BOT_EMAIL }}
33+
GIT_SET_GLOBAL_USER: true
34+
- name: Build docs
35+
run: mkdocs build
36+
- name: Deploy docs
37+
uses: JamesIves/github-pages-deploy-action@v4
38+
with:
39+
folder: site
40+
token: ${{ secrets.GH_BOT_TOKEN }}
41+
git-config-name: ${{ vars.GH_BOT_NAME }}
42+
git-config-email: ${{ vars.GH_BOT_EMAIL }}

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,6 @@ captures
5050
.turbo
5151
/packages/*/lib
5252
build/
53+
54+
# mkdocs
55+
site/

‎docs/assets/logo.png‎

10.6 KB
Loading

‎docs/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Async Storage
2+
3+
Asynchronous, persistent, key-value storage system for React Native.

‎docs/stylesheets/extra.css‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:root {
2+
--md-primary-fg-color: #32b982;
3+
--md-primary-fg-color--light: #4dcca0;
4+
--md-primary-fg-color--dark: #24986b;
5+
6+
--md-accent-fg-color: #ff7a59;
7+
--md-accent-fg-color--light: #ff9c85;
8+
--md-accent-fg-color--dark: #cc6046;
9+
}
10+
11+
a.md-header__button.md-logo {
12+
padding: 0;
13+
margin: 0;
14+
}
15+
16+
.md-header__button.md-logo img {
17+
height: 48px; /* adjust as needed */
18+
width: auto; /* keep aspect ratio */
19+
}

‎mkdocs.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
site_name: Async Storage
2+
repo_url: https://github.com/react-native-async-storage/async-storage
3+
site_url: https://react-native-async-storage.github.io/
4+
5+
nav:
6+
- Introduction: index.md
7+
8+
theme:
9+
name: material
10+
palette:
11+
primary: custom
12+
accent: custom
13+
logo: assets/logo.png
14+
favicon: assets/logo.png
15+
icon:
16+
repo: fontawesome/brands/github
17+
feature:
18+
- navigation.tabs
19+
- navigation.footer
20+
- content.code.copy
21+
22+
extra_css:
23+
- stylesheets/extra.css
24+
25+
markdown_extensions:
26+
- admonition
27+
- pymdownx.inlinehilite
28+
- pymdownx.snippets
29+
- pymdownx.details
30+
- pymdownx.superfences
31+
- pymdownx.tabbed:
32+
alternate_style: true
33+
- pymdownx.highlight:
34+
anchor_linenums: true
35+
line_spans: __span
36+
pygments_lang_class: true
37+
- toc:
38+
permalink: true
39+
40+
extra:
41+
social:
42+
- icon: fontawesome/brands/github
43+
name: Async Storage
44+
link: https://github.com/react-native-async-storage/async-storage
45+
version:
46+
provider: mike

‎package.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
"test:ts": "turbo run test:ts",
1515
"test:format": "prettier --check --loglevel warn $(git ls-files '*.js' '*.json' '*.ts' '*.tsx' '*.yml' 'README.md')",
1616
"release:version": "./.github/scripts/setup-ci-git-user.sh && changeset version",
17-
"release:publish": "./.github/scripts/setup-ci-git-user.sh && changeset publish"
17+
"release:publish": "./.github/scripts/setup-ci-git-user.sh && changeset publish",
18+
"docs:serve": "mkdocs serve",
19+
"docs:build": "mkdocs build"
1820
},
1921
"devDependencies": {
2022
"@changesets/cli": "^2.27.7",

0 commit comments

Comments
 (0)