Skip to content

Commit

Permalink
fix(documentation): Improved markdown highlighting (#104)
Browse files Browse the repository at this point in the history
  • Loading branch information
andys8 authored and daffl committed May 29, 2018
1 parent e61b285 commit 9b49ea7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This version is configured to work with Swagger UI 3.x

## Installation

```
```shell
npm install feathers-swagger --save
```

Expand Down Expand Up @@ -75,17 +75,17 @@ const app = feathers()
app.listen(3030);
```

Go to `localhost:3030/docs` to see the Swagger JSON documentation.
Go to <http://localhost:3030/docs> to see the Swagger JSON documentation.

### Example with Feathers Generate app
1. Go into your `src/services/` folder, and open the service you want to edit `PATH.service.js`
2. Change from this:
```
```js
// Initialize our service with any options it requires
app.use('/events', createService(options));
```
to this:
```
```js
const events = createService(options)
events.docs = {
//overwrite things here.
Expand Down Expand Up @@ -342,7 +342,7 @@ Create a `docs.html` page like this:
</html>
```

Now [localhost:3030/docs/](http://localhost:3030/docs/) will show the documentation in the browser using the Swagger UI.
Now <http://localhost:3030/docs/> will show the documentation in the browser using the Swagger UI.

You can also use `uiIndex: true` to use the default [Swagger UI](http://swagger.io/swagger-ui/).

Expand Down Expand Up @@ -392,6 +392,6 @@ app.listen(3030);

## License

Copyright (c) 2016
Copyright (c) 2016 - 2018

Licensed under the [MIT license](LICENSE).

0 comments on commit 9b49ea7

Please sign in to comment.