Skip to content

Commit 218c3ea

Browse files
daviwildaviwil
committed
FIXUP: Doc template
1 parent 08e27a0 commit 218c3ea

File tree

10 files changed

+576
-3
lines changed

10 files changed

+576
-3
lines changed

‎docs/docfx.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@
6464
}
6565
],
6666
"dest": "_site",
67-
"template": [
68-
"default"
69-
]
67+
"template": [ "default", "template" ]
7068
}
7169
}

‎docs/images/PowerShell_logo.png

2.15 KB
Loading

‎docs/template/conceptual.html.primary.tmpl

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
{{!include(/^styles/.*/)}}
3+
{{!include(/^fonts/.*/)}}
4+
{{!include(favicon.ico)}}
5+
{{!include(logo.svg)}}
6+
<!DOCTYPE html>
7+
<!--[if IE]><![endif]-->
8+
<html>
9+
{{>partials/head}}
10+
<body data-spy="scroll" data-target="#affix">
11+
<div id="wrapper">
12+
<header>
13+
{{^_disableNavbar}}
14+
{{>partials/navbar}}
15+
{{/_disableNavbar}}
16+
{{^_disableBreadcrumb}}
17+
{{>partials/breadcrumb}}
18+
{{/_disableBreadcrumb}}
19+
</header>
20+
<div role="main" class="container body-content">
21+
{{^_disableToc}}
22+
{{>partials/toc}}
23+
<div class="article row grid-right">
24+
{{/_disableToc}}
25+
{{#_disableToc}}
26+
<div class="article row grid">
27+
{{/_disableToc}}
28+
{{#_disableAffix}}
29+
<div class="col-md-12">
30+
{{/_disableAffix}}
31+
{{^_disableAffix}}
32+
<div class="col-md-10">
33+
{{/_disableAffix}}
34+
<article class="content wrap" id="_content">
35+
{{^_disableContribution}}
36+
{{#docurl}}
37+
<a href="{{docurl}}" class="pull-right mobile-hide"><span class="fa fa-github"></span> Improve this Doc</a>
38+
{{/docurl}}
39+
{{/_disableContribution}}
40+
{{{rawTitle}}}
41+
{{{conceptual}}}
42+
</article>
43+
</div>
44+
{{^_disableAffix}}
45+
{{>partials/affix}}
46+
{{/_disableAffix}}
47+
</div>
48+
</div>
49+
{{^_disableFooter}}
50+
{{>partials/footer}}
51+
{{/_disableFooter}}
52+
</div>
53+
{{>partials/scripts}}
54+
</body>
55+
</html>

‎docs/template/partials/class.tmpl.partial

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
{{^_disableContribution}}
4+
{{#docurl}}<a href="{{docurl}}" class="pull-right mobile-hide"><span class="fa fa-github"></span>{{__global.improveThisDoc}}</a>{{/docurl}}
5+
{{#sourceurl}}<a href="{{sourceurl}}" class="pull-right mobile-hide">{{__global.viewSource}}</a>{{/sourceurl}}
6+
{{/_disableContribution}}
7+
<h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
8+
<div class="markdown level0 summary">{{{summary}}}</div>
9+
<div class="markdown level0 conceptual">{{{conceptual}}}</div>
10+
{{#inheritance.0}}
11+
<div class="inheritance">
12+
<h5>{{__global.inheritance}}</h5>
13+
{{#inheritance}}
14+
<div class="level{{index}}">{{{specName.0.value}}}</div>
15+
{{/inheritance}}
16+
<div class="level{{item.level}}"><span class="xref">{{item.name.0.value}}</span></div>
17+
</div>
18+
{{/inheritance.0}}
19+
<h6><strong>{{__global.namespace}}</strong>:{{namespace}}</h6>
20+
<h6><strong>{{__global.assembly}}</strong>:{{assemblies.0}}.dll</h6>
21+
<h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
22+
<div class="codewrapper">
23+
<pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
24+
</div>
25+
{{#remarks}}
26+
<h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
27+
<div class="markdown level0 remarks">{{{remarks}}}</div>
28+
{{/remarks}}
29+
{{#children}}
30+
<h3 id="{{id}}">{{>partials/classSubtitle}}</h3>
31+
{{#children}}
32+
{{^_disableContribution}}
33+
{{#docurl}}
34+
<span class="small pull-right mobile-hide">
35+
<span class="divider">|</span>
36+
<a href="{{docurl}}">{{__global.improveThisDoc}}</a>
37+
</span>{{/docurl}}
38+
{{#sourceurl}}
39+
<span class="small pull-right mobile-hide">
40+
<a href="{{sourceurl}}">{{__global.viewSource}}</a>
41+
</span>{{/sourceurl}}
42+
{{/_disableContribution}}
43+
<h4 id="{{id}}" data-uid="{{uid}}">{{name.0.value}}</h4>
44+
<div class="markdown level1 summary">{{{summary}}}</div>
45+
<div class="markdown level1 conceptual">{{{conceptual}}}</div>
46+
{{#remarks}}
47+
<h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
48+
<div class="markdown level1 remarks">{{{remarks}}}</div>
49+
{{/remarks}}
50+
<h5 class="decalaration">{{__global.declaration}}</h5>
51+
{{#syntax}}
52+
<div class="codewrapper">
53+
<pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
54+
</div>
55+
{{#parameters.0}}
56+
<h5 class="parameters">{{__global.parameters}}</h5>
57+
<table class="table table-bordered table-striped table-condensed">
58+
<thead>
59+
<tr>
60+
<th>{{__global.type}}</th>
61+
<th>{{__global.name}}</th>
62+
<th>{{__global.description}}</th>
63+
</tr>
64+
</thead>
65+
<tbody>
66+
{{/parameters.0}}
67+
{{#parameters}}
68+
<tr>
69+
<td>{{{type.specName.0.value}}}</td>
70+
<td><em>{{{id}}}</em></td>
71+
<td>{{{description}}}</td>
72+
</tr>
73+
{{/parameters}}
74+
{{#parameters.0}}
75+
</tbody>
76+
</table>
77+
{{/parameters.0}}
78+
{{#return}}
79+
<h5 class="returns">{{__global.returns}}</h5>
80+
<table class="table table-bordered table-striped table-condensed">
81+
<thead>
82+
<tr>
83+
<th>{{__global.type}}</th>
84+
<th>{{__global.description}}</th>
85+
</tr>
86+
</thead>
87+
<tbody>
88+
<tr>
89+
<td>{{{type.specName.0.value}}}</td>
90+
<td>{{{description}}}</td>
91+
</tr>
92+
</tbody>
93+
</table>
94+
{{/return}}
95+
{{#propertyValue}}
96+
<h5 class="propertyValue">{{__global.provertyValue}}</h5>
97+
<table class="table table-bordered table-striped table-condensed">
98+
<thead>
99+
<tr>
100+
<th>{{__global.type}}</th>
101+
<th>{{__global.description}}</th>
102+
</tr>
103+
</thead>
104+
<tbody>
105+
<tr>
106+
<td>{{{type.specName.0.value}}}</td>
107+
<td>{{{description}}}</td>
108+
</tr>
109+
</tbody>
110+
</table>
111+
{{/propertyValue}}
112+
{{/syntax}}
113+
{{#exceptions.0}}
114+
<h5 class="exceptions">{{__global.exceptions}}</h5>
115+
<table class="table table-bordered table-striped table-condensed">
116+
<thead>
117+
<tr>
118+
<th>{{__global.type}}</th>
119+
<th>{{__global.condition}}</th>
120+
</tr>
121+
</thead>
122+
<tbody>
123+
{{/exceptions.0}}
124+
{{#exceptions}}
125+
<tr>
126+
<td>{{{type.specName.0.value}}}</td>
127+
<td>{{{description}}}</td>
128+
</tr>
129+
{{/exceptions}}
130+
{{#exceptions.0}}
131+
</tbody>
132+
</table>
133+
{{/exceptions.0}}
134+
{{/children}}
135+
{{/children}}

‎docs/template/partials/footer.tmpl.partial

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
<footer>
4+
<div class="inner-footer">
5+
<p>© Microsoft &nbsp;//&nbsp; Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
6+
</div>
7+
</footer>

‎docs/template/partials/head.tmpl.partial

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
6+
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
7+
<meta name="viewport" content="width=device-width">
8+
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
9+
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
10+
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
11+
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.css">
12+
<link rel="stylesheet" href="{{_rel}}styles/main.css">
13+
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
14+
<link rel="stylesheet" href="{{_rel}}styles/style.css">
15+
<meta property="docfx:navrel" content="{{_navRel}}">
16+
<meta property="docfx:tocrel" content="{{_tocRel}}">
17+
<!--
18+
<script>
19+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
20+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
21+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
22+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
23+
24+
ga('create', 'UA-63735192-1', 'auto');
25+
ga('send', 'pageview');
26+
</script>
27+
-->
28+
</head>

‎docs/template/partials/namespace.tmpl.partial

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
{{^_disableContribution}}
4+
{{#docurl}}
5+
<a href="{{docurl}}" class="pull-right mobile-hide"><span class="fa fa-github"></span>{{__global.improveThisDoc}}</a>
6+
{{/docurl}}
7+
{{#sourceurl}}
8+
<a href="{{sourceurl}}" class="pull-right mobile-hide">{{__global.viewSource}}</a>
9+
{{/sourceurl}}
10+
{{/_disableContribution}}
11+
<h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
12+
<div class="markdown level0 summary">{{{summary}}}</div>
13+
<div class="markdown level0 conceptual">{{{conceptual}}}</div>
14+
<div class="markdown level0 remarks">{{{remarks}}}</div>
15+
{{#children}}
16+
<h3 id="{{id}}">{{>partials/namespaceSubtitle}}</h3>
17+
{{#children}}
18+
<h4>{{{specName.0.value}}}</h4>
19+
<section>{{{summary}}}</section>
20+
{{/children}}
21+
{{/children}}

‎docs/template/partials/navbar.tmpl.partial

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
<nav class="navbar navbar-inverse">
4+
<div class="container">
5+
<a href="{{_rel}}"><img height="50px" src="{{_rel}}images/PowerShell_logo.png" style="float:right;"/></a>
6+
<div class="navbar-header ">
7+
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
8+
<span class="sr-only">Toggle navigation</span>
9+
<span class="icon-bar"></span>
10+
<span class="icon-bar"></span>
11+
<span class="icon-bar"></span>
12+
</button>
13+
<a class="navbar-brand" href="{{_rel}}"><span class="dotnet">PowerShell Editor Services</span></a>
14+
</div>
15+
<div id="navbar" class="collapse navbar-collapse">
16+
</div><!--/.nav-collapse -->
17+
</div>
18+
</nav>

0 commit comments

Comments
 (0)