mirror of
https://github.com/rclone/rclone.git
synced 2025-08-19 01:46:31 +02:00
docs: ensure empty line between text and a following heading
This commit is contained in:
@@ -11,8 +11,7 @@ import (
|
||||
|
||||
// AuthHelp returns text describing the http authentication to add to the command help.
|
||||
func AuthHelp(prefix string) string {
|
||||
help := `
|
||||
#### Authentication
|
||||
help := `#### Authentication
|
||||
|
||||
By default this will serve files without needing a login.
|
||||
|
||||
@@ -38,6 +37,7 @@ The password file can be updated while rclone is running.
|
||||
Use ` + "`--{{ .Prefix }}realm`" + ` to set the authentication realm.
|
||||
|
||||
Use ` + "`--{{ .Prefix }}salt`" + ` to change the password hashing salt from the default.
|
||||
|
||||
`
|
||||
tmpl, err := template.New("auth help").Parse(help)
|
||||
if err != nil {
|
||||
|
@@ -27,8 +27,7 @@ import (
|
||||
// Help returns text describing the http server to add to the command
|
||||
// help.
|
||||
func Help(prefix string) string {
|
||||
help := `
|
||||
### Server options
|
||||
help := `### Server options
|
||||
|
||||
Use ` + "`--{{ .Prefix }}addr`" + ` to specify which IP address and port the server should
|
||||
listen on, eg ` + "`--{{ .Prefix }}addr 1.2.3.4:8000` or `--{{ .Prefix }}addr :8080`" + ` to listen to all
|
||||
@@ -74,6 +73,7 @@ certificate authority certificate.
|
||||
--{{ .Prefix }}min-tls-version is minimum TLS version that is acceptable. Valid
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
|
||||
"tls1.0").
|
||||
|
||||
`
|
||||
tmpl, err := template.New("server help").Parse(help)
|
||||
if err != nil {
|
||||
|
@@ -16,8 +16,7 @@ import (
|
||||
|
||||
// TemplateHelp returns a string that describes how to use a custom template
|
||||
func TemplateHelp(prefix string) string {
|
||||
help := `
|
||||
#### Template
|
||||
help := `#### Template
|
||||
|
||||
` + "`--{{ .Prefix }}template`" + ` allows a user to specify a custom markup template for HTTP
|
||||
and WebDAV serve functions. The server exports the following markup
|
||||
@@ -52,6 +51,7 @@ be used to render HTML based on specific conditions.
|
||||
| contains | Checks whether a given substring is present or not in a given string. |
|
||||
| hasPrefix | Checks whether the given string begins with the specified prefix. |
|
||||
| hasSuffix | Checks whether the given string end with the specified suffix. |
|
||||
|
||||
`
|
||||
|
||||
tmpl, err := template.New("template help").Parse(help)
|
||||
|
Reference in New Issue
Block a user