Skip to content

Commit 0d2e36b

Browse files
committed
update README
1 parent c2ac43c commit 0d2e36b

File tree

1 file changed

+8
-90
lines changed

1 file changed

+8
-90
lines changed

README.md

Lines changed: 8 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -11,105 +11,23 @@ WordPress plugin to generate a static copy of your site and deploy to GitHub Pag
1111
- [WP2Static](https://github.com/WP2Static/wp2static)
1212
- [SimplerStatic](https://github.com/WP2Static/simplerstatic)
1313

14-
## Table of contents
15-
16-
* [External resources](#external-resources)
17-
* [Opinionated software](#opinionated-software)
18-
* [WP-CLI commands](#wp-cli-commands)
19-
* [Hooks](#hooks)
20-
* [Modify the initial list of URLs to crawl](#modify-the-initial-list-of-urls-to-crawl)
21-
* [Post-deployment hook](#post-deployment-hook)
22-
* [Development](#development)
23-
* [Localisation / translations](#localisation--translations)
24-
* [Support](#support)
25-
26-
## External resources
27-
2814
- [Static HTML Output on wordpress.org](https://wordpress.org/plugins/static-html-output-plugin)
2915
- [Homepage](https://statichtmloutput.com)
3016
- [Documentation](https://statichtmloutput.com/docs/)
3117
- [Forum](https://forum.wp2static.com)
3218

33-
3419
## WP-CLI commands
3520

36-
- `wp statichtmloutput options --help`
37-
```
38-
NAME
39-
40-
wp statichtmloutput options
41-
42-
DESCRIPTION
43-
44-
Read / write plugin options
45-
46-
SYNOPSIS
47-
48-
wp statichtmloutput options
49-
50-
OPTIONS
51-
52-
<list> [--reveal-sensitive-values]
53-
54-
Get all option names and values (explicitly reveal sensitive values)
55-
56-
<get> <option-name>
57-
58-
Get or set a specific option via name
59-
60-
<set> <option-name> <value>
61-
62-
Set a specific option via name
63-
64-
65-
EXAMPLES
66-
67-
List all options
68-
69-
wp statichtmloutput options list
70-
71-
List all options (revealing sensitive values)
72-
73-
wp statichtmloutput options list --reveal_sensitive_values
74-
75-
Get option
76-
77-
wp statichtmloutput options get selected_deployment_option
78-
79-
Set option
80-
81-
wp statichtmloutput options set baseUrl 'https://mystaticsite.com'
82-
```
83-
- `wp statichtmloutput generate`
84-
85-
```
86-
Generating static copy of WordPress site
87-
Success: Generated static site archive in 00:00:04
88-
```
89-
90-
- `wp statichtmloutput deploy --test`
91-
- `wp statichtmloutput deploy`
92-
- `wp statichtmloutput generate`
93-
94-
```
95-
Generating static copy of WordPress site
96-
Success: Generated static site archive in 00:00:04
97-
```
98-
99-
- `wp statichtmloutput deploy --test`
100-
- `wp statichtmloutput deploy`
101-
102-
```
103-
Deploying static site via: zip
104-
Success: Deployed to: zip in 00:00:01
105-
Sending confirmation email...
106-
```
21+
- `wp statichtmloutput COMMAND`
10722

108-
Delete deploy cache
23+
Where `COMMAND` can be any of:
10924

110-
`wp statichtmloutput deploy_cache delete`
25+
- `options`
26+
- `generate`
27+
- `deploy`
28+
- `deploy_cache`
11129

112-
With option `--force`, else will prompt for confirmation.
30+
Get help for any command by appending `--help`
11331

11432
## Hooks
11533

@@ -214,5 +132,5 @@ Localisation within the plugin isn't supported. Rather, it's recommended to use
214132

215133
## Support
216134

217-
Please [raise an issue](https://github.com/WP2Static/static-html-output-plugin/issues/new) here on GitHub or on the plugin's [support forum](https://forum.statichtmloutput.com).
135+
Please [raise an issue](https://github.com/WP2Static/static-html-output-plugin/issues/new) here on GitHub or on the plugin's [support forum](https://forum.wp2static.com).
218136

0 commit comments

Comments
 (0)