Repo-Mirror/cloudflare-error-page
9
0
Fork 0
mirror of https://github.com/donlon/cloudflare-error-page.git synced 2025-12-19 14:59:28 +00:00
Code Issues Releases Activity

doc: update README.md

Browse Source
This commit is contained in:
Anthony Donlon
2025-11-19 20:27:02 +08:00
parent e157aee7c9
commit a3757f3a76
2 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1,11 +1,21 @@
# Customizable Cloudflare error page generator # Cloudflare Error Page Generator
## QuickStart Guide (Python) ## What does this project do?
This project creates customized error pages that mimics Cloudflare's error page. And you can embed it into your website.
![Default error page](doc/default.png)
## Quickstart
Install cloudflare-error-page using pip
``` Bash ``` Bash
pip install git+https://github.com/donlon/cloudflare-error-page.git pip install git+https://github.com/donlon/cloudflare-error-page.git
``` ```
Then you can generate an error page based on parameters you like. (See [example.py](examples/example.py))
``` Python ``` Python
import webbrowser import webbrowser
from cloudflare_error_page import render as render_cf_error_page from cloudflare_error_page import render as render_cf_error_page
@@ -34,7 +44,9 @@ with open('error.html', 'w') as f:
webbrowser.open('error.html') webbrowser.open('error.html')
``` ```
## Examples ## More Examples
### Catastrophic infrastructure failure
``` Python ``` Python
params = { params = {

BIN
doc/default.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 49 KiB