Skip to content

Commit 132f1d3

Browse files
committed
docs: move code blocks outside list items for MkDocs compatibility
1 parent a35faed commit 132f1d3

File tree

9 files changed

+116
-124
lines changed

9 files changed

+116
-124
lines changed

docs/configuration/ui/custom-css.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,16 @@ Each theme includes support for custom CSS extension files that are automaticall
1515

1616
## Quick Start
1717

18-
1. Navigate to your theme's style directory:
19-
20-
```
21-
templates/default/style/
22-
```
23-
24-
2. Copy the example files:
25-
26-
```bash
27-
cp custom_light.css.example custom_light.css
28-
cp custom_dark.css.example custom_dark.css
29-
```
30-
18+
1. Navigate to your theme's style directory: `templates/default/style/`
19+
2. Copy the example files (see below)
3120
3. Edit the CSS files to match your preferences
32-
3321
4. Refresh your browser - custom styles are automatically loaded
3422

23+
```bash
24+
cp custom_light.css.example custom_light.css
25+
cp custom_dark.css.example custom_dark.css
26+
```
27+
3528
## How It Works
3629

3730
| File | Description |

docs/configuration/ui/layout.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,16 @@ return [
2525

2626
### Creating Custom Templates
2727

28-
1. Create a directory structure for your custom theme:
28+
1. Create a directory structure for your custom theme (see below)
29+
2. Create the following files (see sections below)
2930

30-
```
31-
templates/
32-
└── custom/
33-
├── header.html
34-
├── footer.html
35-
└── other template files...
36-
```
37-
38-
2. Create the following files:
31+
```
32+
templates/
33+
└── custom/
34+
├── header.html
35+
├── footer.html
36+
└── other template files...
37+
```
3938

4039
#### Custom Header (templates/custom/header.html)
4140

docs/configuration/ui/themes.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,17 @@ Each theme includes consistent styling for:
4747
Poweradmin supports custom themes through the theme templates system. To create a custom theme:
4848

4949
1. Set the theme to `custom` in your settings
50-
2. Create a directory structure in your theme base path:
51-
52-
```
53-
templates/
54-
└── custom/
55-
├── header.html
56-
├── footer.html
57-
└── other template files...
58-
```
59-
50+
2. Create a directory structure in your theme base path (see below)
6051
3. Customize the template files to match your organization's branding
6152

53+
```
54+
templates/
55+
└── custom/
56+
├── header.html
57+
├── footer.html
58+
└── other template files...
59+
```
60+
6261
## Theme Customization
6362

6463
For more information on customizing themes, see:

docs/contributing/development.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,25 @@
1010
- PowerDNS server (for testing)
1111

1212
### Installation for Development
13-
1. Clone the repository
1413

15-
```
16-
git clone https://github.com/poweradmin/poweradmin.git
17-
cd poweradmin
18-
```
14+
**1. Clone the repository:**
1915

20-
2. Install dependencies
16+
```
17+
git clone https://github.com/poweradmin/poweradmin.git
18+
cd poweradmin
19+
```
20+
21+
**2. Install dependencies:**
2122

22-
```
23-
composer install
24-
npm install
25-
```
23+
```
24+
composer install
25+
npm install
26+
```
2627

27-
3. Configure the application
28-
- Copy `config/settings.defaults.php` to a new file in the same directory
29-
- Modify the settings according to your environment
28+
**3. Configure the application:**
29+
30+
- Copy `config/settings.defaults.php` to a new file in the same directory
31+
- Modify the settings according to your environment
3032

3133
## Project Structure
3234

@@ -74,13 +76,14 @@ Poweradmin has comprehensive testing support including unit tests, integration t
7476
Poweradmin follows PSR-12 with project-specific modifications. For detailed information on coding standards, tools for code quality, and how to enforce them, see the [Coding Standards Guide](coding-standards.md).
7577

7678
## Database Migrations
79+
7780
- Database migrations are managed with Phinx
7881
- See `db/migrations/` for existing migrations
7982
- Create new migrations with:
8083

81-
```
82-
./vendor/bin/phinx create MyNewMigration
83-
```
84+
```
85+
./vendor/bin/phinx create MyNewMigration
86+
```
8487

8588
## Contributing
8689
1. Fork the repository

docs/installation/centos.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -29,71 +29,71 @@ dnf install -y php-sqlite3
2929

3030
### Apache
3131

32-
1. Install Apache if not already installed:
32+
**1. Install Apache if not already installed:**
3333

34-
```bash
35-
dnf install -y httpd
36-
```
34+
```bash
35+
dnf install -y httpd
36+
```
3737

38-
2. Enable and start the Apache service:
38+
**2. Enable and start the Apache service:**
3939

40-
```bash
41-
systemctl enable httpd
42-
systemctl start httpd
43-
```
40+
```bash
41+
systemctl enable httpd
42+
systemctl start httpd
43+
```
4444

45-
3. Configure SELinux if it's enabled:
45+
**3. Configure SELinux if it's enabled:**
4646

47-
```bash
48-
# Allow Apache to connect to the database
49-
setsebool -P httpd_can_network_connect_db 1
47+
```bash
48+
# Allow Apache to connect to the database
49+
setsebool -P httpd_can_network_connect_db 1
5050

51-
# If using a non-standard directory, set the correct context
52-
semanage fcontext -a -t httpd_sys_content_t "/path/to/poweradmin(/.*)?"
53-
restorecon -Rv /path/to/poweradmin
54-
```
51+
# If using a non-standard directory, set the correct context
52+
semanage fcontext -a -t httpd_sys_content_t "/path/to/poweradmin(/.*)?"
53+
restorecon -Rv /path/to/poweradmin
54+
```
5555

56-
4. Configure your firewall:
56+
**4. Configure your firewall:**
5757

58-
```bash
59-
firewall-cmd --permanent --add-service=http
60-
firewall-cmd --permanent --add-service=https # If using HTTPS
61-
firewall-cmd --reload
62-
```
58+
```bash
59+
firewall-cmd --permanent --add-service=http
60+
firewall-cmd --permanent --add-service=https # If using HTTPS
61+
firewall-cmd --reload
62+
```
6363

64-
5. Ensure `AllowOverride All` is set in your Apache configuration to allow the `.htaccess` file to function properly. The `.htaccess` file handles URL routing, API support, and security rules automatically.
64+
**5.** Ensure `AllowOverride All` is set in your Apache configuration to allow the `.htaccess` file to function properly. The `.htaccess` file handles URL routing, API support, and security rules automatically.
6565

6666
### Nginx Configuration
6767

6868
If you prefer Nginx, use the configuration example provided in the Poweradmin repository. The configuration includes API routing, CORS support, security rules, and clean URL handling.
6969

70-
1. Install Nginx:
70+
**1. Install Nginx:**
7171

72-
```bash
73-
dnf install -y nginx
74-
```
72+
```bash
73+
dnf install -y nginx
74+
```
7575

76-
2. Download the appropriate configuration file:
76+
**2.** Download the appropriate configuration file:
7777

7878
**Version-specific configuration files:**
7979

8080
- **Poweradmin 4.0.x**: Use [nginx.conf.example from release/4.x](https://github.com/poweradmin/poweradmin/blob/release/4.x/nginx.conf.example)
8181
- **Poweradmin 4.1.x+**: Use [nginx.conf.example from master](https://github.com/poweradmin/poweradmin/blob/master/nginx.conf.example) (includes subfolder deployment support)
8282

83-
3. Save the configuration to `/etc/nginx/conf.d/poweradmin.conf` and adjust:
83+
**3.** Save the configuration to `/etc/nginx/conf.d/poweradmin.conf` and adjust:
8484

8585
- `server_name` - Set to your domain name
8686
- `root` - Set to your Poweradmin installation path
8787
- `fastcgi_pass` - Use `unix:/var/run/php-fpm/www.sock` for RHEL/CentOS
8888

89-
4. Enable and start Nginx and PHP-FPM:
89+
**4. Enable and start Nginx and PHP-FPM:**
9090

91-
```bash
92-
systemctl enable nginx php-fpm
93-
systemctl start nginx php-fpm
94-
```
91+
```bash
92+
systemctl enable nginx php-fpm
93+
systemctl start nginx php-fpm
94+
```
9595

96-
5. Configure SELinux and firewall as with Apache.
96+
**5.** Configure SELinux and firewall as with Apache.
9797

9898
### Caddy Configuration
9999

docs/installation/docker-secrets.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -174,26 +174,26 @@ EOF
174174

175175
## Security Best Practices
176176

177-
1. **File permissions**: Set restrictive permissions on secret files
177+
**1. File permissions:** Set restrictive permissions on secret files:
178178

179179
```bash
180180
chmod 600 ./secrets/*
181181
```
182182

183-
2. **Read-only mounts**: Mount secrets as read-only
183+
**2. Read-only mounts:** Mount secrets as read-only:
184184

185-
```yaml
186-
volumes:
187-
- ./secrets/db_password.txt:/run/secrets/db_password:ro
188-
```
185+
```yaml
186+
volumes:
187+
- ./secrets/db_password.txt:/run/secrets/db_password:ro
188+
```
189189
190-
3. **Exclude from version control**: Add secrets to `.gitignore`
190+
**3. Exclude from version control:** Add secrets to `.gitignore`:
191191

192-
```
193-
secrets/
194-
*.key
195-
*.pem
196-
```
192+
```
193+
secrets/
194+
*.key
195+
*.pem
196+
```
197197
198198
4. **Use external secrets in production**: For Swarm deployments, use external secrets managed outside of compose files
199199

docs/installation/remote-setup-guide.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -92,16 +92,16 @@ PRIVILEGES;
9292

9393
For DNSSEC management and certain operations, Poweradmin requires access to the PowerDNS API:
9494

95-
1. Enable the API on your PowerDNS server by editing `/etc/powerdns/pdns.conf`:
96-
97-
```
98-
api=yes
99-
api-key=your_secure_api_key
100-
webserver=yes
101-
webserver-address=0.0.0.0 # Or restrict to admin_server_ip
102-
webserver-port=8081
103-
webserver-allow-from=admin_server_ip/32
104-
```
95+
**1.** Enable the API on your PowerDNS server by editing `/etc/powerdns/pdns.conf`:
96+
97+
```
98+
api=yes
99+
api-key=your_secure_api_key
100+
webserver=yes
101+
webserver-address=0.0.0.0 # Or restrict to admin_server_ip
102+
webserver-port=8081
103+
webserver-allow-from=admin_server_ip/32
104+
```
105105

106106
2. Configure Poweradmin to use the API by editing your `settings.php`:
107107

docs/upgrading/v4.0.0.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ After successfully running the migration script and verifying your new configura
4747
- Keep this backup temporarily while testing
4848
- Delete it once you're confident everything works: `rm inc/config.inc.php.bak`
4949

50-
2. **If you kept the original file (answered "n"):**
51-
52-
```bash
53-
# Backup and remove the old config
54-
mv inc/config.inc.php inc/config.inc.php.backup
55-
# Store it safely outside the web root
56-
mv inc/config.inc.php.backup ~/poweradmin-backups/config.inc.php.$(date +%Y%m%d)
57-
```
50+
**If you kept the original file (answered "n"):**
51+
52+
```bash
53+
# Backup and remove the old config
54+
mv inc/config.inc.php inc/config.inc.php.backup
55+
# Store it safely outside the web root
56+
mv inc/config.inc.php.backup ~/poweradmin-backups/config.inc.php.$(date +%Y%m%d)
57+
```
5858

5959
3. **Clean up other legacy files:**
6060
- You can safely remove `.old`, `.bak`, or other backup files from the `inc/` directory

docs/upgrading/v4.1.0.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,17 +109,15 @@ Four new pre-configured permission templates are included:
109109

110110
Customize the Poweradmin interface with CSS files that persist across upgrades:
111111

112-
1. Copy example files in `templates/default/style/`:
113-
114-
```bash
115-
cp custom_light.css.example custom_light.css
116-
cp custom_dark.css.example custom_dark.css
117-
```
118-
112+
1. Copy example files in `templates/default/style/`
119113
2. Edit the CSS files with your customizations
120-
121114
3. Changes are automatically loaded for the corresponding theme
122115

116+
```bash
117+
cp custom_light.css.example custom_light.css
118+
cp custom_dark.css.example custom_dark.css
119+
```
120+
123121
See [Custom CSS](../configuration/ui/custom-css.md) for details.
124122

125123
### Username Recovery

0 commit comments

Comments
 (0)