Skip to content

Commit

Permalink
(GitToolsGH-1932) Update readme information about docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gep13 committed Nov 27, 2019
1 parent b614c28 commit bb0fa58
Showing 1 changed file with 6 additions and 16 deletions.
22 changes: 6 additions & 16 deletions docs/input/docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,13 @@ it to ensure that everything works as expected.

## Serving the documentation locally

To serve up the documentation locally, you need to
[install MkDocs](http://www.mkdocs.org/#installation) and then at the root of
the GitVersion project write the following in a command line window:
To serve up the documentation locally, you need to run the following build
command:

```shell
mkdocs serve
.\build.ps1 --target=preview
```

After pressing enter, something similar to the following lines should appear:

```
INFO - Building documentation...
INFO - Cleaning site directory
[I 160810 10:48:18 server:281] Serving on http://127.0.0.1:8000
```

If it says `Serving on http://127.0.0.1:8000`, you should be able to navigate
your favorite browser to `http://127.0.0.1:8000` and browse the documentation
there. If you have any problems with this process, please consult the
[MkDocs documentation](http://www.mkdocs.org/).
After pressing enter, the documentation will be generated and then served under
a local web server. Information about the URL that can be used to view the docs
will be shown in the output. Copy/paste this URL into a browser window.

0 comments on commit bb0fa58

Please sign in to comment.