Skip to content

Commit 7970428

Browse files
committed
Fix README headings
Github Flavored markdown requires a space between the ## and the text.
1 parent a5bf293 commit 7970428

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@
55

66
A navigation helper service for Angular client applications.
77

8-
##Dependencies
8+
## Dependencies
99

1010
* AngularJS - http://angularjs.org
1111
* Lodash - http://lodash.com
12+
13+
## Configurable Dependencies
14+
1215
* ng-authentication-service - https://github.com/justinsa/angular-authentication-service
1316

1417
The ng-navigation-service was designed in tandem with the ng-authentication-service, but it is not a hard requirement. The configured security service must support the following API:
1518

1619
1. ```boolean isAuthenticated()```
1720
2. ```[String] roles()```
1821

19-
##Basic Setup
22+
## Basic Setup
2023

2124
Add this module to your app as a dependency:
2225
```JAVASCRIPT
@@ -37,7 +40,7 @@ Inject $navigation as a parameter in declarations that require it:
3740
app.controller('yourController', function($scope, $navigation){ ... });
3841
```
3942

40-
##Configuration Options
43+
## Configuration Options
4144

4245
To override the default configuration options, configure the module with an options argument during application configuration and provide overrides for any of the following options.
4346

@@ -59,15 +62,15 @@ app.config(['$navigationProvider', function ($navigationProvider) {
5962
}]);
6063
```
6164

62-
##API
65+
## API
6366

64-
###inAudience
67+
### inAudience
6568
```JAVASCRIPT
6669
// returns true if the user is in any of the specified audiences
6770
$navigation.inAudience('X', 'Y', 'Z');
6871
```
6972

70-
###isActiveLocation
73+
### isActiveLocation
7174
```JAVASCRIPT
7275
// returns true if the location is the current active location
7376
// the following will match any location that starts with the /dashboard route
@@ -78,7 +81,7 @@ $navigation.isActiveLocation('/dashboard');
7881
$navigation.isActiveLocation('dashboard/user');
7982
```
8083

81-
###decorateLink
84+
### decorateLink
8285
```JAVASCRIPT
8386
// $navigation.decorateLink(item, active, inactive);
8487
// returns the active decorator if the location is the current active location (see isActiveLocation).
@@ -92,28 +95,28 @@ $navigation.decorateLink('/dashboard', 'active-item', undefined);
9295
$navigation.decorateLink('/dashboard');
9396
```
9497

95-
###goto
98+
### goto
9699
```JAVASCRIPT
97100
// Navigate to a route and optionally push the current location to history.
98101
$navigation.goto(route, noHistory);
99102
```
100103

101-
###back
104+
### back
102105
```JAVASCRIPT
103106
// Pop and navigate to the previous location from history.
104107
$navigation.back();
105108
```
106109

107-
##Additional Methods
110+
## Additional Methods
108111
These methods were primarily implemented for testing or utility purposes, but they may be useful in special scenarios and are part of the exposed API.
109112

110-
###getConfiguration
113+
### getConfiguration
111114
```JAVASCRIPT
112115
// Get the configuration options
113116
$navigation.getConfiguration();
114117
```
115118

116-
###tokenizePath
119+
### tokenizePath
117120
```JAVASCRIPT
118121
// $navigation.tokenizePath(location);
119122
// returns an in-order array of lowercase tokens from a location string.
@@ -125,7 +128,7 @@ $navigation.tokenizePath('/dashboard');
125128
// overridden by the value of ``$location.path()``.
126129
```
127130

128-
##Development
131+
## Development
129132
After forking you should only have to run ```npm install``` from a command line to get your environment setup.
130133

131134
After install you have two gulp commands available to you:

0 commit comments

Comments
 (0)