From debcad62927607c3facce5f34b4b4d0adc518b66 Mon Sep 17 00:00:00 2001 From: xing Date: Thu, 11 May 2023 13:40:28 +0800 Subject: [PATCH] en readme --- README.md | 3 +++ readme_en.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+) create mode 100644 readme_en.md diff --git a/README.md b/README.md index 144f3bb..b6add44 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ ## wp-go +[en readme](https://github.com/fthvgb1/wp-go/blob/master/readme_en.md) + 一个go写的WordPress的前端，功能比较简单，只有列表页和详情页,rss2，主题只有twentyfifteen和twentyseventeen两套主题，插件的话只有一个简单的列表页的摘要生成和enlighter代码高亮。本身只用于展示文章及评论。要求go的版本在1.20以上，越新越好。。。 #### 特色功能 @@ -7,6 +9,7 @@ - 基本实现全站缓存，并且可防止缓存击穿 - 列表页也可以高亮语法格式化显示代码 - 简易插件扩展开发机制、配置后支持热加载更新 +- 使用.so扩展主题、插件、路由等 - 丰富繁杂的配置，呃，配置是有点儿多，虽然大部分都是可选项。。。 - 添加评论或panic时发邮件通知，包涵栈调用和请求信息 - 简单的流量限制中间件，可以限制全瞬时最大请求数量 diff --git a/readme_en.md b/readme_en.md new file mode 100644 index 0000000..8712aa2 --- /dev/null +++ b/readme_en.md @@ -0,0 +1,74 @@ +## wp-go + +A WordPress front-end written in Go, with relatively simple functions, only the list page and detail page, rss2, the theme only has two sets of twentyfifteen and twentyseventeen themes, and the plug-in only has a simple summary generation of the list page and highlighter code highlighting. It is only used to display articles and comments. The go version is required to be above 1.20, the newer the better. . . + +#### + +#### Special feature + +- Basically realize the whole site cache and prevent cache breakdown +- The list page can also highlight the syntax and format the code +- Simple plug-in extension development mechanism , support hot loading update after configuration +- can build .so extend theme , plug-in ,route and so on +- Rich and complicated configurations, uh, there are a lot of configurations, although most of them are optional. . . +- Send an email notification when adding a comment or panic, including stack calls and request information +- Simple traffic limit middleware, which can limit the maximum number of requests in an instant +- Package all static resources into the execution file except the configuration file +- Support password viewing, and the cookie information can be verified by the php version +- Support rss2 subscription +- Hot update configuration, switch theme, clear cache + - kill -SIGUSR1 PID update configuration and clear cache + - kill -SIGUSR2 PID clear cache + +#### The data show the degree of support + +| page table | Support | +|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| List | Home/Search/Archive/Categories/Tags/Author Paginated List | +| Details page | Display content, comments and add comments (for forwarding php processing, you need to configure the url for adding comments in the php version) | +| Sidebar | Support the old version of recent articles, recent comments, regulations, categories, and other operation display and settings, and support the new version of classification | + +#### background settings support + +- dash board + - Exterior + - small tools + - search + - Regulations + - recent articles + - recent comments + - Classification + - other operations +- set up- + - conventional + - site title + - subtitle + - read + - The maximum number of blog pages displayed + - The most recent quantity is shown in the feed + - discuss + - Other comment settings - enable comment nesting, up to the number of nesting layers + - Show `new|old`comments + +#### Theme support + +| twentyfifteen | twentyseventeen | +|--------------------|-------------------------------------------| +| site identity | site identity | +| color | color | +| header image | Header Media (Video is not supported yet) | +| Background picture | extra css | +| extra css | | + +#### Plug-in mechanism + +It is divided into plug-ins that modify the data of list pages and plug-ins that affect the performance of the entire program + +| List page article data plugin | Plugins for whole program performance | +|----------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| digest Automatically generate a digest of the specified length | Enlighter code highlighting (enlighterjs plug-in needs to be installed in the background) | +| | hiddenLogin hidden login entry | + +#### other + +The gin framework and sqlx used encapsulate the layer query method outside. \ No newline at end of file