Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

Commit 4776560

Browse files
authored
Merge pull request #9 from zaherg/create-github-pages
simple github pages
2 parents 48a8b86 + 36c341f commit 4776560

File tree

5 files changed

+132
-0
lines changed

5 files changed

+132
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
/packages
77

88
.env
9+
.continuerules
910

1011
# misc
1112
.DS_Store

docs/_config.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
remote_theme: just-the-docs/just-the-docs
2+
title: LitePress
3+
description: A modern WordPress development environment with SQLite integration
4+
color_scheme: dark
5+
6+
# Enable search
7+
search_enabled: false
8+
9+
# Aux links for the upper right navigation
10+
aux_links:
11+
"LitePress on GitHub":
12+
- "https://github.com/zaherg/litepress"
13+
14+
# Makes Aux links open in a new tab
15+
aux_links_new_tab: true
16+
17+
# Sort pages by title
18+
nav_sort: case_sensitive
19+
20+
# Footer content
21+
footer_content: "Copyright © 2025 Zaher Ghaibeh. Distributed under an MIT license."

docs/development.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: default
3+
title: Development
4+
nav_order: 3
5+
---
6+
7+
# Development Guide
8+
9+
## Project Structure
10+
11+
LitePress follows modern WordPress development practices:
12+
13+
- `public/content/plugins` - Plugins
14+
- `public/content/themes` - Themes
15+
- `public/content/mu-plugins/` - Must-use plugins
16+
- `public/wp/` - WordPress core (managed by Composer)
17+
18+
## Local Development
19+
20+
1. Clone the repository
21+
2. Run `composer install`
22+
3. Configure your `.env` file
23+
4. Start development!
24+
25+
## Reinstallation
26+
27+
To reset your project:
28+
29+
```bash
30+
ADMIN_PASSWORD="your-password" composer run re-install
31+
```
32+
33+
## Important Notes
34+
35+
- Some WordPress plugins may not support SQLite due to MySQL-specific syntax
36+
- Environment variable changes require container restart when using Docker
37+
- Use WordPress coding standards for development

docs/docker-setup.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: default
3+
title: Docker Setup
4+
nav_order: 2
5+
---
6+
7+
# Docker Setup
8+
9+
LitePress includes Docker support for easy development. Here's how to get started:
10+
11+
## Prerequisites
12+
13+
- Docker
14+
- Docker Compose
15+
- LitePress installed via Composer
16+
17+
## Configuration
18+
19+
1. Configure environment variables in `.env`:
20+
```env
21+
NGINX_PORT=80 # Change if port 80 is in use
22+
REDIS_PORT=6379 # Change if port 6379 is in use
23+
```
24+
25+
## Starting Docker
26+
27+
Run the following command:
28+
29+
```bash
30+
docker-compose up -d
31+
```
32+
33+
Your application will be available at `http://127.0.0.1` (or your configured port).
34+
35+
## Docker Stack
36+
37+
The Docker setup includes:
38+
- PHP-FPM with Nginx
39+
- Redis for caching
40+
- Automatic environment configuration

docs/index.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: default
3+
title: Home
4+
nav_order: 1
5+
---
6+
7+
# LitePress Documentation
8+
9+
Welcome to LitePress - a modern WordPress development environment that uses Composer and includes SQLite integration out of the box.
10+
11+
## Quick Start
12+
13+
### Simple Setup
14+
15+
```bash
16+
composer create-project zaherg/litepress litepress
17+
```
18+
19+
### Advanced Setup
20+
21+
```bash
22+
ADMIN_USER="your-username" \
23+
ADMIN_PASSWORD="your-password" \
24+
ADMIN_EMAIL="admin@example.com" \
25+
WP_HOME="http://your-site-url.test" \
26+
SITE_TITLE="Your Site Title" \
27+
composer create-project zaherg/litepress litepress
28+
```
29+
30+
## Default Credentials
31+
When using simple setup:
32+
- Username: `admin`
33+
- Password: `password`

0 commit comments

Comments
 (0)