Skip to content

Commit

Permalink
Fix formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
zerodevx committed Jul 26, 2019
1 parent 90e60ca commit 541b68e
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Simple CLI to pre-generate XML sitemaps for static sites locally.
Built in 10 minutes. :stuck_out_tongue_winking_eye:


### Install
## Install

```
npm i -g static-sitemap-cli
```


### Usage
## Usage

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

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

**Clean URLs**
#### Clean URLs

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

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

Pass `-n` option to disable this behavior.

**Trailing Slashes**
#### Trailing Slashes

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

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


### Examples
## Examples

**Create sitemap for `dist/` folder**
#### Create sitemap for `dist/` folder

```
static-sitemap-cli https://example.com -r dist/ > dist/sitemap.xml
```

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

**Ignore a bunch of files**
#### Ignore a bunch of files

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

**Set priority of certain pages**
#### Set priority of certain pages

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


### To-do
## To-do

Add tests! :sweat_smile:


### Changelog
## Changelog

**v0.1.0 - 2019-07-26:**
* Initial release.
Expand Down

0 comments on commit 541b68e

Please sign in to comment.