Skip to content

Commit 12be556

Browse files
committed
chore: Cleanup README
No need to include deploy and structure info. Structure will require us to keep it up to date, and deploy isn't required for contributing
1 parent e2f58a0 commit 12be556

File tree

2 files changed

+2
-142
lines changed

2 files changed

+2
-142
lines changed

README.md

Lines changed: 0 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -28,146 +28,6 @@ npm run build
2828

2929
Generates static content into the `build` directory for deployment.
3030

31-
## 📖 Documentation Structure
32-
33-
```
34-
docs/
35-
├── intro.md # Documentation homepage
36-
├── installation.md # Installation guide
37-
├── quick_start.md # Quick start guide
38-
├── configuration.md # Configuration guide
39-
├── client_configuration.md # Client configuration
40-
├── deployment/
41-
│ ├── docker-compose.md # Docker Compose options
42-
│ ├── m3u-proxy-integration.md # M3U Proxy setup
43-
│ └── caddy-vs-nginx.md # Reverse proxy comparison
44-
├── integrations/
45-
│ ├── emby_integration.md # Emby integration guide
46-
│ ├── emby_integration_settings.md # Emby settings reference
47-
│ └── roadmap_integrations.md # Integration roadmap
48-
├── resources/
49-
│ ├── playlists.md # Playlists overview
50-
│ ├── custom-playlist.md # Custom playlist guide
51-
│ ├── merged-playlist.md # Merged playlist setup
52-
│ ├── playlist-alias.md # Playlist aliasing
53-
│ ├── playlist-auth.md # Playlist authentication
54-
│ ├── playlist-pooled_providers.md # Pooled providers
55-
│ └── epg-setup.md # EPG setup guide
56-
└── advanced/
57-
├── auto-merge-channels.md # Auto-merge feature
58-
├── environment-variables.md # Environment variables
59-
├── epg-optimization.md # EPG caching & performance
60-
├── settings-reference.md # Settings reference
61-
└── strm-files.md # STRM files guide
62-
```
63-
64-
## 🌐 Deployment
65-
66-
### GitHub Pages (Recommended)
67-
68-
This documentation is configured for GitHub Pages deployment:
69-
70-
1. **Enable GitHub Pages** in your repository settings:
71-
- Go to Settings → Pages
72-
- Source: Deploy from a branch
73-
- Branch: `gh-pages` (root)
74-
75-
2. **Deploy using GitHub Actions**:
76-
```bash
77-
git add .
78-
git commit -m "Update documentation"
79-
git push
80-
```
81-
82-
The GitHub Actions workflow will automatically:
83-
- Build the documentation
84-
- Deploy to GitHub Pages
85-
- Make it available at `https://sparkison.github.io/m3u-editor-docs-v2/`
86-
87-
3. **Manual Deployment** (alternative):
88-
```bash
89-
npm run deploy
90-
```
91-
92-
### Custom Domain
93-
94-
To use a custom domain:
95-
96-
1. Add a `CNAME` file in `static/`:
97-
```
98-
docs.yourdomainhere.com
99-
```
100-
101-
2. Configure DNS:
102-
- Add a CNAME record pointing to `sparkison.github.io`
103-
104-
3. Update `docusaurus.config.js`:
105-
```javascript
106-
url: 'https://docs.yourdomainhere.com',
107-
baseUrl: '/',
108-
```
109-
110-
### Self-Hosting
111-
112-
To self-host the documentation:
113-
114-
1. **Build the site**:
115-
```bash
116-
npm run build
117-
```
118-
119-
2. **Serve the `build` directory** with any web server:
120-
121-
**Nginx:**
122-
```nginx
123-
server {
124-
listen 80;
125-
server_name docs.yourdomain.com;
126-
root /path/to/build;
127-
index index.html;
128-
129-
location / {
130-
try_files $uri $uri/ /index.html;
131-
}
132-
}
133-
```
134-
135-
**Apache:**
136-
```apache
137-
<VirtualHost *:80>
138-
DocumentRoot /path/to/build
139-
<Directory /path/to/build>
140-
AllowOverride All
141-
Require all granted
142-
RewriteEngine On
143-
RewriteCond %{REQUEST_FILENAME} !-f
144-
RewriteCond %{REQUEST_FILENAME} !-d
145-
RewriteRule ^ index.html [L]
146-
</RewriteRule>
147-
</VirtualHost>
148-
```
149-
150-
**Docker:**
151-
```dockerfile
152-
FROM nginx:alpine
153-
COPY build /usr/share/nginx/html
154-
COPY nginx.conf /etc/nginx/conf.d/default.conf
155-
```
156-
157-
### Vercel / Netlify
158-
159-
Both Vercel and Netlify can deploy Docusaurus sites:
160-
161-
**Vercel:**
162-
1. Import repository
163-
2. Build command: `npm run build`
164-
3. Output directory: `build`
165-
166-
**Netlify:**
167-
1. Import repository
168-
2. Build command: `npm run build`
169-
3. Publish directory: `build`
170-
17131
## 🛠️ Configuration
17232

17333
### Site Configuration

sandbox.config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
"hardReloadOnChange": true,
44
"view": "browser",
55
"template": "docusaurus",
6-
"node": "18",
6+
"node": "20",
77
"container": {
8-
"node": "18"
8+
"node": "20"
99
}
1010
}

0 commit comments

Comments
 (0)