Skip to content

Commit 541b68e

Browse files
committed
Fix formatting
1 parent 90e60ca commit 541b68e

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ Simple CLI to pre-generate XML sitemaps for static sites locally.
55
Built in 10 minutes. :stuck_out_tongue_winking_eye:
66

77

8-
### Install
8+
## Install
99

1010
```
1111
npm i -g static-sitemap-cli
1212
```
1313

1414

15-
### Usage
15+
## Usage
1616

1717
Syntax: `static-sitemap-cli <BASEURL> <options>`
1818

@@ -46,15 +46,15 @@ By default outputs to `stdout`. So that you can pipe it to do other stuff.
4646
| -n | --no-clean | disable clean URLs |
4747
| -s | --slash | add trailing slash to all URLs |
4848

49-
**Clean URLs**
49+
#### Clean URLs
5050

5151
Whether or not to include the `.html` extension. By default, something like:
5252

5353
`https://example.com/foo/index.html` becomes `https://example.com/foo`.
5454

5555
Pass `-n` option to disable this behavior.
5656

57-
**Trailing Slashes**
57+
#### Trailing Slashes
5858

5959
Control whether or not URLs should include trailing slashes. For example:
6060

@@ -63,23 +63,23 @@ Control whether or not URLs should include trailing slashes. For example:
6363
For obvious reasons, this cannot be used together with `-n`.
6464

6565

66-
### Examples
66+
## Examples
6767

68-
**Create sitemap for `dist/` folder**
68+
#### Create sitemap for `dist/` folder
6969

7070
```
7171
static-sitemap-cli https://example.com -r dist/ > dist/sitemap.xml
7272
```
7373

7474
Note: Just put `dist/` for that location, not `dist/.` or `./dist/**`.
7575

76-
**Ignore a bunch of files**
76+
#### Ignore a bunch of files
7777

7878
```
7979
static-sitemap-cli https://example.com -i 404.html,foo/*.html > sm.xml
8080
```
8181

82-
**Set priority of certain pages**
82+
#### Set priority of certain pages
8383

8484
By default, the optional `<priority>` label ([protocol reference](https://www.sitemaps.org/protocol.html)) is excluded,
8585
so every pages' default is 0.5. To change the *relative* priority (to 0.1) of certain pages:
@@ -89,12 +89,12 @@ static-sitemap-cli https://example.com -p **/privacy-policy/**,0.1 **/terms-of-s
8989
```
9090

9191

92-
### To-do
92+
## To-do
9393

9494
Add tests! :sweat_smile:
9595

9696

97-
### Changelog
97+
## Changelog
9898

9999
**v0.1.0 - 2019-07-26:**
100100
* Initial release.

0 commit comments

Comments
 (0)