Skip to content

Page title tweak #1581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 3, 2018
Merged

Page title tweak #1581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf05eed
add a h1 title to the page content
devoncarew Jan 3, 2018
8e2f63b
commit the golden doc files
devoncarew Jan 3, 2018
7bfa021
Merge branch 'master' into page_title_tweak
devoncarew Jan 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions lib/resources/styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,7 @@ ul.subnav li:last-of-type {
.sidebar ol {
list-style: none;
line-height: 22px;
margin-top: 0;
margin-bottom: 0;
padding: 0 0 15px 0;
}
Expand Down
4 changes: 2 additions & 2 deletions lib/src/html/template_data.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ abstract class TemplateData<T extends Documentable> {

String _layoutTitle(String name, String kind, bool isDeprecated) {
if (isDeprecated) {
return '${kind} <span class="deprecated">${name}</span>';
return '<span class="deprecated">${name}</span> ${kind}';
} else {
return '${kind} ${name}';
return '${name} ${kind}';
}
}

Expand Down
4 changes: 2 additions & 2 deletions lib/templates/class.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_library}}
</div>

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{{self.nameWithGenerics}}} {{self.kind}}</h1>

{{#clazz}}
{{>documentation}}
Expand Down Expand Up @@ -161,7 +162,6 @@ <h2>Constants</h2>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
{{>sidebar_for_class}}
</div><!--/.sidebar-offcanvas-->

Expand Down
4 changes: 2 additions & 2 deletions lib/templates/constant.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_class}}
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{self.name}} {{self.kind}}</h1>

<section class="multi-line-signature">
{{#property}}
Expand All @@ -24,7 +25,6 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
</div><!--/.sidebar-offcanvas-->

{{>footer}}
5 changes: 3 additions & 2 deletions lib/templates/constructor.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_class}}
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{{self.nameWithGenerics}}} {{self.kind}}</h1>

{{#constructor}}
<section class="multi-line-signature">
{{#hasAnnotations}}
Expand All @@ -29,7 +31,6 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
</div><!--/.sidebar-offcanvas-->

{{>footer}}
4 changes: 2 additions & 2 deletions lib/templates/enum.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_library}}
</div>

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{self.name}} {{self.kind}}</h1>

{{#eNum}}
{{>documentation}}
Expand Down Expand Up @@ -161,7 +162,6 @@ <h2>Static Methods</h2>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
{{>sidebar_for_enum}}
</div><!--/.sidebar-offcanvas-->

Expand Down
4 changes: 2 additions & 2 deletions lib/templates/function.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_library}}
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{{self.nameWithGenerics}}} {{self.kind}}</h1>

{{#function}}
<section class="multi-line-signature">
Expand All @@ -19,7 +20,6 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
</div><!--/.sidebar-offcanvas-->

{{>footer}}
2 changes: 1 addition & 1 deletion lib/templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{self.kind}} {{self.name}}</h5>
<h5>{{self.name}} {{self.kind}}</h5>

{{#useCategories}}
<ol>
Expand Down
5 changes: 3 additions & 2 deletions lib/templates/library.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{#useCategories}}
<ol>
{{#package.categories}}
Expand All @@ -24,6 +24,7 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div>

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{self.name}} {{self.kind}}</h1>

{{#library}}
{{>documentation}}
Expand Down Expand Up @@ -131,7 +132,7 @@ <h2>Exceptions / Errors</h2>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
<h5>{{self.name}} {{self.kind}}</h5>
{{>sidebar_for_library}}
</div><!--/sidebar-offcanvas-right-->

Expand Down
5 changes: 3 additions & 2 deletions lib/templates/method.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_class}}
</div><!--/.sidebar-offcanvas-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{{self.nameWithGenerics}}} {{self.kind}}</h1>

{{#method}}
<section class="multi-line-signature">
{{>callable_multiline}}
Expand All @@ -18,7 +20,6 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
</div><!--/.sidebar-offcanvas-->

{{>footer}}
5 changes: 3 additions & 2 deletions lib/templates/property.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_class}}
</div><!--/.sidebar-offcanvas-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{self.name}} {{self.kind}}</h1>

{{#self}}
{{#hasNoGetterSetter}}
<section class="multi-line-signature">
Expand All @@ -30,7 +32,6 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
</div><!--/.sidebar-offcanvas-->

{{>footer}}
4 changes: 2 additions & 2 deletions lib/templates/top_level_constant.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_library}}
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{self.name}} {{self.kind}}</h1>

{{#self}}
<section class="multi-line-signature">
Expand All @@ -22,7 +23,6 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
</div><!--/.sidebar-offcanvas-->

{{>footer}}
5 changes: 3 additions & 2 deletions lib/templates/top_level_property.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_library}}
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{self.name}} {{self.kind}}</h1>

{{#self}}
{{#hasNoGetterSetter}}
<section class="multi-line-signature">
Expand All @@ -28,7 +30,6 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
</div><!--/.sidebar-offcanvas-->

{{>footer}}
4 changes: 2 additions & 2 deletions lib/templates/typedef.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{{>head}}

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>{{parent.kind}} {{parent.name}}</h5>
<h5>{{parent.name}} {{parent.kind}}</h5>
{{>sidebar_for_library}}
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>{{{self.nameWithGenerics}}} {{self.kind}}</h1>

<section class="multi-line-signature">
{{#typeDef}}
Expand All @@ -21,7 +22,6 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>{{self.kind}} {{self.name}}</h5>
</div><!--/.sidebar-offcanvas-->

{{>footer}}
7 changes: 4 additions & 3 deletions testing/test_package_docs/anonymous_library/anonymous_library-library.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="index.html">test_package</a></li>
<li class="self-crumb">library anonymous_library</li>
<li class="self-crumb">anonymous_library library</li>
</ol>
<div class="self-name">anonymous_library</div>
<form class="search navbar-right" role="search">
Expand All @@ -35,7 +35,7 @@
<main>

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>package test_package</h5>
<h5>test_package package</h5>

<ol>
<li class="section-title"><a href="index.html#libraries">Libraries</a></li>
Expand All @@ -54,6 +54,7 @@ <h5>package test_package</h5>
</div>

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>anonymous_library library</h1>



Expand Down Expand Up @@ -81,7 +82,7 @@ <h2>Functions</h2>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>library anonymous_library</h5>
<h5>anonymous_library library</h5>
<ol>


Expand Down
6 changes: 3 additions & 3 deletions testing/test_package_docs/anonymous_library/doesStuff.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="index.html">test_package</a></li>
<li><a href="anonymous_library/anonymous_library-library.html">anonymous_library</a></li>
<li class="self-crumb">function doesStuff</li>
<li class="self-crumb">doesStuff function</li>
</ol>
<div class="self-name">doesStuff</div>
<form class="search navbar-right" role="search">
Expand All @@ -36,7 +36,7 @@
<main>

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>library anonymous_library</h5>
<h5>anonymous_library library</h5>
<ol>


Expand All @@ -50,6 +50,7 @@ <h5>library anonymous_library</h5>
</div><!--/.sidebar-offcanvas-left-->

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>doesStuff function</h1>

<section class="multi-line-signature">
<span class="returntype">String</span>
Expand All @@ -61,7 +62,6 @@ <h5>library anonymous_library</h5>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>function doesStuff</h5>
</div><!--/.sidebar-offcanvas-->

</main>
Expand Down
7 changes: 4 additions & 3 deletions testing/test_package_docs/another_anonymous_lib/another_anonymous_lib-library.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="index.html">test_package</a></li>
<li class="self-crumb">library another_anonymous_lib</li>
<li class="self-crumb">another_anonymous_lib library</li>
</ol>
<div class="self-name">another_anonymous_lib</div>
<form class="search navbar-right" role="search">
Expand All @@ -35,7 +35,7 @@
<main>

<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5>package test_package</h5>
<h5>test_package package</h5>

<ol>
<li class="section-title"><a href="index.html#libraries">Libraries</a></li>
Expand All @@ -54,6 +54,7 @@ <h5>package test_package</h5>
</div>

<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>another_anonymous_lib library</h1>



Expand Down Expand Up @@ -81,7 +82,7 @@ <h2>Functions</h2>
</div> <!-- /.main-content -->

<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
<h5>library another_anonymous_lib</h5>
<h5>another_anonymous_lib library</h5>
<ol>


Expand Down
Loading