Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Deploy Documentation

on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/deploy-docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: docs/package-lock.json

- name: Install dependencies
run: npm ci

- name: Build website
run: npm run build

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ Native Modal implementation which allows to display multiple Modals simultaneous

![React Native Multiple Modals](./assets/preview.gif)

## πŸ“š Documentation

For comprehensive documentation, visit: **[https://paufau.github.io/react-native-multiple-modals/](https://paufau.github.io/react-native-multiple-modals/)**

The documentation includes:
- πŸ“– [Installation Guide](https://paufau.github.io/react-native-multiple-modals/installation)
- πŸš€ [Usage Examples](https://paufau.github.io/react-native-multiple-modals/usage)
- πŸ”§ [API Reference](https://paufau.github.io/react-native-multiple-modals/api/properties)
- πŸ› [Troubleshooting](https://paufau.github.io/react-native-multiple-modals/troubleshooting)
- 🀝 [Contributing](https://paufau.github.io/react-native-multiple-modals/contribution)

## ✨ Features

- πŸš€ Shows multiple instances at the same time
Expand Down Expand Up @@ -160,7 +171,7 @@ Follow instructions: https://github.com/paufau/react-native-multiple-modals-exam

Common:

- Create separate documentation page
- βœ… Create separate documentation page - [View Docs](https://paufau.github.io/react-native-multiple-modals/)

## Troubleshooting

Expand Down
20 changes: 20 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
43 changes: 43 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# React Native Multiple Modals - Documentation

This directory contains the Docusaurus-based documentation for React Native Multiple Modals.

## Quick Start

### Local Development

```bash
npm install
npm start
```

### Build

```bash
npm run build
```

## Deployment

The documentation automatically deploys to GitHub Pages via GitHub Actions on changes to `main`.

**Initial Setup** (one-time):
1. Go to repository Settings β†’ Pages
2. Set Source to "GitHub Actions"
3. Verify workflow permissions in Settings β†’ Actions β†’ General

Once configured, the site will be live at: https://paufau.github.io/react-native-multiple-modals/

## Structure

- `docs/` - Documentation markdown files
- `static/` - Static assets (images, etc.)
- `docusaurus.config.ts` - Configuration
- `sidebars.ts` - Sidebar structure

## Contributing

1. Edit markdown files in `docs/`
2. Test locally with `npm start`
3. Build to verify: `npm run build`
4. Submit a pull request
Loading