Skip to content

Commit 286c956

Browse files
author
erundle
committed
Improving look and feel of documentation
1 parent 99780f5 commit 286c956

File tree

6 files changed

+88
-11
lines changed

6 files changed

+88
-11
lines changed

Gruntfile.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,9 @@ module.exports = function (grunt) {
104104
},
105105
ngdocs: {
106106
options: {
107-
title: 'Angular-Patternfly Documentation',
107+
title: 'Angular Patternfly Documentation',
108108
dest: 'dist/docs',
109+
image: 'misc/logo-alt.svg',
109110
scripts: ['lib/patternfly/components/jquery/dist/jquery.js',
110111
'lib/patternfly/components/bootstrap/dist/js/bootstrap.js',
111112
'lib/patternfly/components/bootstrap-combobox/js/bootstrap-combobox.js',

dist/angular-patternfly.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1550,7 +1550,7 @@ angular.module('patternfly.charts').directive('pfUtilizationChart',
15501550
);
15511551
;/**
15521552
* @ngdoc directive
1553-
* @name patternfly.fitlers.directive:pfSimpleFilter
1553+
* @name patternfly.filters.directive:pfSimpleFilter
15541554
*
15551555
* @description
15561556
* Directive for a simple filter bar

grunt-ngdocs-index.tmpl

+14-8
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
<header class="header">
9393
<div class="navbar navbar-fixed-top">
9494
<div class="navbar-inner">
95-
<div class="container navbar-default">
95+
<div class="container-fluid navbar-inverse">
9696
<% if (image) { %>
9797
<% if (imageLink) { %>
9898
<a href="<%= imageLink %>">
@@ -103,6 +103,9 @@
103103
<% } %>
104104
<% } %>
105105
<% if (title) {%>
106+
<% if (imageLink) { %>
107+
<img class="pull-left" src="<%= imageLink %>">
108+
<% } %>
106109
<a <% if (titleLink) { %> href="<%= titleLink %>" <% } %> class="navbar-brand"><%= title %></a>
107110
<% } %>
108111
<%= navContent %>
@@ -111,7 +114,7 @@
111114
</div>
112115
</header>
113116

114-
<div role="main" class="container">
117+
<div role="main" class="container-fluid">
115118
<div class="row clear-navbar"></div>
116119

117120
<div class="row">
@@ -139,8 +142,9 @@
139142
<div class="col-md-3">
140143
<form class="form-search" ng-submit="submitForm()">
141144
<% if (bestMatch) { %>
142-
<div class="dropdown search"
145+
<div class="dropdown search docs-search"
143146
ng-class="{open: focused && bestMatch.rank > 0 && bestMatch.page != currentPage}">
147+
<span class="fa fa-search search-icon"></span>
144148
<input type="text" ng-model="search" placeholder="search the docs"
145149
tabindex="1" accesskey="s" class="search-query" focused="focused">
146150
<ul class="dropdown-menu">
@@ -150,8 +154,11 @@
150154
</ul>
151155
</div>
152156
<% } else { %>
153-
<input type="text" ng-model="search" placeholder="search the docs"
157+
<div class="docs-search">
158+
<span class="fa fa-search search-icon"></span>
159+
<input type="text" ng-model="search" placeholder="search the docs"
154160
tabindex="1" accesskey="s" class="search-query">
161+
</div>
155162
<% } %>
156163
<div class="spacer"></div>
157164

@@ -221,13 +228,12 @@
221228
</div>
222229
<div class="col-md-9">
223230

224-
<ul class="breadcrumb">
225-
<li ng-repeat="crumb in breadcrumb">
231+
<ol class="breadcrumb">
232+
<li ng-repeat="crumb in breadcrumb" ng-class="{'active': !crumb.url}">
226233
<span ng-hide="crumb.url">{{crumb.name}}</span>
227234
<a ng-show="crumb.url" href="{{crumb.url}}">{{crumb.name}}</a>
228-
<span ng-show="crumb.url" class="divider">/</span>
229235
</li>
230-
</ul>
236+
</ol>
231237

232238
<div id="loading" ng-show="loading">Loading...</div>
233239

misc/demo.css

+52
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,55 @@
1+
/* Docs overrides */
2+
.navbar img {
3+
height: 35px;
4+
width: 57px;
5+
margin-top: 8px;
6+
margin-right: 0px;
7+
}
8+
9+
.navbar-inverse .navbar-brand {
10+
color: #fff;
11+
padding: 15px 20px 15px 0;
12+
text-transform: uppercase;
13+
}
14+
15+
.breadcrumb li > * {
16+
float: none;
17+
margin: 0;
18+
}
19+
20+
.form-search .module .guide {
21+
padding-top: 6px;
22+
}
23+
24+
.form-search > ul.nav > li.section {
25+
min-height: 23px;
26+
}
27+
28+
.docs-search {
29+
margin: 10px 0;
30+
padding: 4px 0 4px 20px;
31+
background: #fff;
32+
border: 1px solid #bbb;
33+
vertical-align: middle;
34+
}
35+
36+
.docs-search > .search-query {
37+
font-size: 14px;
38+
border: 0;
39+
width: 80%;
40+
color: #555;
41+
}
42+
43+
.docs-search > .search-icon {
44+
font-size: 15px;
45+
margin-right: 10px;
46+
}
47+
48+
.docs-search > .search-query:focus {
49+
outline:0;
50+
}
51+
52+
/* Demo CSS */
153
.pf-transclude-example div {
254
border: 1px solid #337ab7;
355
margin-bottom: 20px;

misc/logo-alt.svg

+18
Loading

src/filters/simple-filter-directive.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* @ngdoc directive
3-
* @name patternfly.fitlers.directive:pfSimpleFilter
3+
* @name patternfly.filters.directive:pfSimpleFilter
44
*
55
* @description
66
* Directive for a simple filter bar

0 commit comments

Comments
 (0)