|
1 | | -=== Static HTML Output === |
2 | | -Contributors: leonstafford |
3 | | -Tags: security, performance, static |
4 | | -Requires at least: 3.2 |
5 | | -Tested up to: 5.4.2 |
6 | | -Requires PHP: 7.3 |
7 | | -Stable tag: 6.6.21 |
| 1 | +## Static HTML Output Changelog |
8 | 2 |
|
9 | | -Publish your website as static HTML for improved performance and security. |
| 3 | += 6.6.22 = |
10 | 4 |
|
11 | | -== Description == |
12 | | - |
13 | | -Security & Performance via static website publishing. |
14 | | - |
15 | | -Keep using WordPress for what it's best at - managing content, but remove the security and performance headaches by publishing the site as static HTML. |
16 | | - |
17 | | -A static site closes all the doors that an out of date WordPress, theme or plugin can leave open. |
18 | | - |
19 | | -A pre-generated static site will outperform caching plugins, allowing you to serve at local speeds to users around the world. |
20 | | - |
21 | | -[**https://statichtmloutput.com**](https://statichtmloutput.com/) |
22 | | - |
23 | | -Not compatible with WooCommerce or membership sites, but solutions like [Snipcart](https://snipcart.com) allow for eCommerce on static websites. |
24 | | - |
25 | | -= Features = |
26 | | - |
27 | | - * publishes a standalone, static html copy of your whole WordPress website |
28 | | - * removes tell-tale signs your site is running WordPress, making it unattractive to hackers |
29 | | - * auto-deploy to a folder on your server, a ZIP file, S3, GitHub, Netlify, BunnyCDN, BitBucket or GitLab |
30 | | - * schedule unattended exports via the WP Crontrol plugin or by hitting the custom hook |
31 | | - * desktop notifications alert you to when exports are complete |
32 | | - |
33 | | - |
34 | | -= Benefits = |
35 | | - |
36 | | - * protects you from malicious attacks/malware |
37 | | - * speeds up your site by not hitting the database or executing any PHP code |
38 | | - * allows you to host your site for free on GitHub Pages, Netlify or the free tier of AWS S3, Azure, etc |
39 | | - * allows you to deploy to crazy fast hosting options, like S3, behind CloudFront |
40 | | - * have a nice development -> staging -> production workflow and integrate with your CI tools |
41 | | - |
42 | | -= A word from the author = |
43 | | - |
44 | | -[youtube http://www.youtube.com/watch?v=HPc4JjBvkrU] |
45 | | - |
46 | | -= Who loves this? = |
47 | | - |
48 | | - - Digital Agencies with many sites to manage, no need to worry about WP/plugin updates for client sites |
49 | | - - Internet Marketers can create a bunch of quick sites/landing pages that load fast and are free to host |
50 | | - - Solo website owners and content creators who like WordPress but don't want to worry about how to secure it |
51 | | - - Operations people at large corporations don't often like dealing with WordPress, this allows them to close the security holes and have more control over the hosting |
52 | | - - Budget conscious people like free hosting (who doesn't?!?) |
53 | | - - Government agencies who have strict security requirements, but have users who prefer to use WordPress |
54 | | - * Thos who want to use it to archive an old WordPress website, keeping the content online, but not worrying about keeping WP up to date |
55 | | - |
56 | | -This plugin produces a static HTML version of your wordpress install, incredibly useful for anyone who would like the publishing power of wordpress but whose webhost doesn't allow dynamic PHP driven sites - such as GitHub Pages. You can run your development site on a different domain or offline, and the plugin will change all relevant URLs when you publish your site. It's a simple but powerful plugin, and after hitting the publish button, the plugin will output a ZIP file of your entire site, ready to upload straight to it's new home. |
57 | | - |
58 | | - |
59 | | -= Getting started = |
60 | | - |
61 | | -Here is the basic premise: |
62 | | - |
63 | | -You need 2 URLs of some sort (they can be on the same server, different servers, subdomains, etc). |
64 | | - |
65 | | - - 1st URL is for where you keep WP - this doesn't need to be accessible or known to anyone but you, if you're the only one working on your content |
66 | | - |
67 | | - - 2nd URL is where you'll "publish" the static version of your site to. This is likely to be your main domain (ie, http://mywordpresssite.com). |
68 | | - |
69 | | -That said, you can install the plugin and do an easy test without any other configuration. This will publish a static version to a subdirectory, such as http://mywordpresssite.com/mystatictest/. That's a good way to check the static site is publishing properly, then you can switch to another deployment option, such as GitHub Pages and deploy to your live site. |
70 | | - |
71 | | -As WordPress allows infinite customization and configurations, I don't think any plugin author would be willing to guarantee complete compatibility with every theme, plugin and custom coding on every site. But my aim is to get as high a % of people as possible able to take advantage of static hosting with their WP site. |
72 | | - |
73 | | - |
74 | | -Developed by [**Leon Stafford**](http://ljs.dev). If you have any questions about this plugin's usage, installation or development, please use the: [GitHub Issues](https://github.com/StaticHTMLOutput/static-html-output-plugin/issues) |
75 | | - |
76 | | -== Installation == |
77 | | - |
78 | | -= via WP Admin panel = |
79 | | - |
80 | | -1. Go to Plugins > Add New |
81 | | -2. Search for "Static HTML Output" |
82 | | -3. Click on the Install Now button |
83 | | -4. Activate the plugin and find it under the Tools menu |
84 | | - |
85 | | -[Watch an installation video](https://youtu.be/kTYlohYGmBk) |
86 | | - |
87 | | -= manual installation = |
88 | | - |
89 | | -1. Upload the static-html-output directory to the `/wp-content/plugins/` directory |
90 | | -2. Activate the plugin through the 'Plugins' menu in WordPress |
91 | | -3. Access the plugin settings from the "Tools" menu |
92 | | - |
93 | | -= via WP CLI = |
94 | | - |
95 | | -1. `wp --allow-root plugin install static-html-output-plugin --activate` |
96 | | - |
97 | | - |
98 | | -== Frequently Asked Questions == |
99 | | - |
100 | | -= How do I configure all the options? = |
101 | | - |
102 | | -There's some useful information on the page once you select a deployment method. There are also some good tutorials linked at https://statichtmloutput.com/ |
103 | | - |
104 | | -= Where can I publish my static site to? = |
105 | | - |
106 | | -Anywhere that allows HTML files to be uploaded, ie: |
107 | | - |
108 | | - * Any FTP server |
109 | | - * GitHub/GitLab/BitBucket Pages (GitHub API integration now included) |
110 | | - * S3 / CloudFront |
111 | | - * Netlify |
112 | | - * BunnyCDN |
113 | | - * Rackspace Cloud Files |
114 | | - |
115 | | -= My export failed - how do I proceed? = |
116 | | - |
117 | | -Everyone's WordPress hosting environment and configuration is unique, with different plugins, themes, PHP versions, to name a few. Whilst the plugin does its best to support all environments, sometimes you'll encounter a new issue. Sometimes we can adjust the settings in the plugin to overcome an issue, other times, it will require a bugfix and a new release of the plugin (usually a quick process). |
118 | | - |
119 | | -== Screenshots == |
120 | | - |
121 | | -1. Deployment screen |
122 | | -2. Crawling options |
123 | | -3. Processing options |
124 | | -4. Advanced options |
125 | | -5. Help & Documentation |
126 | | -6. Detailed log files |
127 | | -7. Ways to support the plugin |
128 | | - |
129 | | -== Changelog == |
| 5 | + * support Windows filepaths |
130 | 6 |
|
131 | 7 | = 6.6.21 = |
132 | 8 |
|
|
0 commit comments