Initial docfx documentation placeholder files (#194)

This is documentation changes only so I'm just going to merge directly.  The PR is for FYI purposes.   Please leave feedback on the commit if you see anything I should follow-up on with this documentation.
This commit is contained in:
Karl Burtram
2016-12-16 12:11:27 -08:00
committed by GitHub
parent 319c5ef7ed
commit 4964a52be5
16 changed files with 703 additions and 0 deletions

View File

@@ -0,0 +1,55 @@
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
{{!include(/^styles/.*/)}}
{{!include(/^fonts/.*/)}}
{{!include(favicon.ico)}}
{{!include(logo.svg)}}
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
{{>partials/head}}
<body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
{{^_disableNavbar}}
{{>partials/navbar}}
{{/_disableNavbar}}
{{^_disableBreadcrumb}}
{{>partials/breadcrumb}}
{{/_disableBreadcrumb}}
</header>
<div role="main" class="container body-content">
{{^_disableToc}}
{{>partials/toc}}
<div class="article row grid-right">
{{/_disableToc}}
{{#_disableToc}}
<div class="article row grid">
{{/_disableToc}}
{{#_disableAffix}}
<div class="col-md-12">
{{/_disableAffix}}
{{^_disableAffix}}
<div class="col-md-10">
{{/_disableAffix}}
<article class="content wrap" id="_content">
{{^_disableContribution}}
{{#docurl}}
<a href="{{docurl}}" class="pull-right mobile-hide"><span class="fa fa-github"></span> Improve this Doc</a>
{{/docurl}}
{{/_disableContribution}}
{{{rawTitle}}}
{{{conceptual}}}
</article>
</div>
{{^_disableAffix}}
{{>partials/affix}}
{{/_disableAffix}}
</div>
</div>
{{^_disableFooter}}
{{>partials/footer}}
{{/_disableFooter}}
</div>
{{>partials/scripts}}
</body>
</html>

View File

@@ -0,0 +1,135 @@
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
{{^_disableContribution}}
{{#docurl}}<a href="{{docurl}}" class="pull-right mobile-hide"><span class="fa fa-github"></span>{{__global.improveThisDoc}}</a>{{/docurl}}
{{#sourceurl}}<a href="{{sourceurl}}" class="pull-right mobile-hide">{{__global.viewSource}}</a>{{/sourceurl}}
{{/_disableContribution}}
<h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
<div class="markdown level0 summary">{{{summary}}}</div>
<div class="markdown level0 conceptual">{{{conceptual}}}</div>
{{#inheritance.0}}
<div class="inheritance">
<h5>{{__global.inheritance}}</h5>
{{#inheritance}}
<div class="level{{index}}">{{{specName.0.value}}}</div>
{{/inheritance}}
<div class="level{{item.level}}"><span class="xref">{{item.name.0.value}}</span></div>
</div>
{{/inheritance.0}}
<h6><strong>{{__global.namespace}}</strong>:{{namespace}}</h6>
<h6><strong>{{__global.assembly}}</strong>:{{assemblies.0}}.dll</h6>
<h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
<div class="codewrapper">
<pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
</div>
{{#remarks}}
<h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
<div class="markdown level0 remarks">{{{remarks}}}</div>
{{/remarks}}
{{#children}}
<h3 id="{{id}}">{{>partials/classSubtitle}}</h3>
{{#children}}
{{^_disableContribution}}
{{#docurl}}
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="{{docurl}}">{{__global.improveThisDoc}}</a>
</span>{{/docurl}}
{{#sourceurl}}
<span class="small pull-right mobile-hide">
<a href="{{sourceurl}}">{{__global.viewSource}}</a>
</span>{{/sourceurl}}
{{/_disableContribution}}
<h4 id="{{id}}" data-uid="{{uid}}">{{name.0.value}}</h4>
<div class="markdown level1 summary">{{{summary}}}</div>
<div class="markdown level1 conceptual">{{{conceptual}}}</div>
{{#remarks}}
<h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
<div class="markdown level1 remarks">{{{remarks}}}</div>
{{/remarks}}
<h5 class="decalaration">{{__global.declaration}}</h5>
{{#syntax}}
<div class="codewrapper">
<pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
</div>
{{#parameters.0}}
<h5 class="parameters">{{__global.parameters}}</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>{{__global.type}}</th>
<th>{{__global.name}}</th>
<th>{{__global.description}}</th>
</tr>
</thead>
<tbody>
{{/parameters.0}}
{{#parameters}}
<tr>
<td>{{{type.specName.0.value}}}</td>
<td><em>{{{id}}}</em></td>
<td>{{{description}}}</td>
</tr>
{{/parameters}}
{{#parameters.0}}
</tbody>
</table>
{{/parameters.0}}
{{#return}}
<h5 class="returns">{{__global.returns}}</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>{{__global.type}}</th>
<th>{{__global.description}}</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{{type.specName.0.value}}}</td>
<td>{{{description}}}</td>
</tr>
</tbody>
</table>
{{/return}}
{{#propertyValue}}
<h5 class="propertyValue">{{__global.provertyValue}}</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>{{__global.type}}</th>
<th>{{__global.description}}</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{{type.specName.0.value}}}</td>
<td>{{{description}}}</td>
</tr>
</tbody>
</table>
{{/propertyValue}}
{{/syntax}}
{{#exceptions.0}}
<h5 class="exceptions">{{__global.exceptions}}</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>{{__global.type}}</th>
<th>{{__global.condition}}</th>
</tr>
</thead>
<tbody>
{{/exceptions.0}}
{{#exceptions}}
<tr>
<td>{{{type.specName.0.value}}}</td>
<td>{{{description}}}</td>
</tr>
{{/exceptions}}
{{#exceptions.0}}
</tbody>
</table>
{{/exceptions.0}}
{{/children}}
{{/children}}

View File

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

View File

@@ -0,0 +1,28 @@
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.css">
<link rel="stylesheet" href="{{_rel}}styles/main.css">
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
<link rel="stylesheet" href="{{_rel}}styles/style.css">
<meta property="docfx:navrel" content="{{_navRel}}">
<meta property="docfx:tocrel" content="{{_tocRel}}">
<!--
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-63735192-1', 'auto');
ga('send', 'pageview');
</script>
-->
</head>

View File

@@ -0,0 +1,21 @@
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
{{^_disableContribution}}
{{#docurl}}
<a href="{{docurl}}" class="pull-right mobile-hide"><span class="fa fa-github"></span>{{__global.improveThisDoc}}</a>
{{/docurl}}
{{#sourceurl}}
<a href="{{sourceurl}}" class="pull-right mobile-hide">{{__global.viewSource}}</a>
{{/sourceurl}}
{{/_disableContribution}}
<h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
<div class="markdown level0 summary">{{{summary}}}</div>
<div class="markdown level0 conceptual">{{{conceptual}}}</div>
<div class="markdown level0 remarks">{{{remarks}}}</div>
{{#children}}
<h3 id="{{id}}">{{>partials/namespaceSubtitle}}</h3>
{{#children}}
<h4>{{{specName.0.value}}}</h4>
<section>{{{summary}}}</section>
{{/children}}
{{/children}}

View File

@@ -0,0 +1,18 @@
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
<nav class="navbar navbar-inverse">
<div class="container">
<a href="{{_rel}}"><img height="50px" src="{{_rel}}images/sqlserver.png" style="float:right;"/></a>
<div class="navbar-header ">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="{{_rel}}"><span class="dotnet">SQL Tools Service</span></a>
</div>
<div id="navbar" class="collapse navbar-collapse">
</div><!--/.nav-collapse -->
</div>
</nav>

268
docs/template/styles/main.css vendored Normal file
View File

@@ -0,0 +1,268 @@
@import url(//fonts.googleapis.com/css?family=Roboto+Condensed:700);
@import url(//fonts.googleapis.com/css?family=Open+Sans);
/* Main styles */
body {
font-family: "Open Sans", "Segoe UI", sans-serif;
font-size: 15px;
padding-top: 50px;
}
ul {
list-style-image: url("../../images/core/list-bullet.png");
}
nav {
font-size: 14px;
}
.navbar-nav > li > a.nav-active, .navbar-nav > li > a.nav-active:hover {
background-color: #333;
color: #fff;
}
h1, h2, h3, h4, h5 {
font-family: "Roboto Condensed", "Segoe UI", sans-serif;
font-weight: bold;
}
footer {
text-align: center;
width: 100%;
margin-top: 50px;
color: #c0c0c0;
}
footer > .inner-footer a {
color: #c0c0c0;
text-decoration: none;
}
footer > .inner-footer a:hover {
color: #32145a;
text-decoration: none;
}
.content a {
/*color: #A979B3;*/
color: #A356B3;
text-decoration: none;
outline: 0;
}
.content a:hover {
/*transition: color .15s cubic-bezier(.33, .66, .66, 1);*/
text-decoration: none;
color: #682079;
}
/* End of main styles */
/* Index page styles */
.btn-hero-core {
padding: 15px 25px;
background-color: #32145a;
color: #d89ae4;
display: inline-block;
font-family: "Open Sans", sans-serif;
font-size: 20px;
font-weight: bold;
margin-left: 20px;
-webkit-box-shadow: 2px 2px 3px 0px #2C0D33; /* Safari 3-4, iOS 4.0.2 - 4.2, Android 2.3+ */
-moz-box-shadow: 2px 2px 3px 0px #2C0D33; /* Firefox 3.5 - 3.6 */
box-shadow: 2px 2px 3px 0px #2C0D33; /* Opera 10.5, IE 9, Firefox 4+, Chrome 6+, iOS 5 */
}
.btn-hero-core:hover {
color: #d89ae4;
text-decoration: none;
}
.hero {
background-color: #682079;
width: inherit;
color: #fff;
}
.starter-template {
padding: 40px 15px;
text-align: center;
}
.dotnet {
color: #fff;
}
#rest-vps {
display: none;
}
.value-prop-heading {
margin-top: 0px;
}
.value-props {
margin-top: 40px;
margin-bottom: 40px;
}
.intro-image {
text-align: center;
}
.intro-image > img {
margin-top: 20px;
}
/* End of index page styles */
/* Getting started page styles */
.getting-started-intro {
text-align: center;
margin-top: 40px;
margin-bottom: 40px;
}
.getting-started-intro > h2, h4 {
margin-bottom: 30px;
}
.btn-gs {
width: 150px;
}
.btn-gs:hover, .btn-gs:active, .btn-gs:focus, .jquery-active {
color: #fff;
background-color: #682079;
outline: 0 !important;
}
.step {
width: 100%;
margin: 50px auto;
padding: 20px 0px;
text-align: center;
font-size: 16px;
border: solid 1px #c0c0c0;
min-height: 300px;
background-color: #fff;
border-radius: 10px;
}
.step-block {
display: block;
}
.step-none {
display: none;
}
.step-number {
position: relative;
top: -40px;
background-color: #32145a;
color: #fff;
font-weight: bold;
font-size: 24px;
z-index: 999;
margin-left: auto;
margin-right: auto;
width: 80px;
padding: 10px;
border: solid 1px #c0c0c0;
border-radius: 10px;
}
.step > h3 {
margin: 0;
margin-bottom: 30px;
font-size: 30px;
}
.step > p {
margin-top: 10px;
margin-bottom: 20px;
width: 70%;
text-align: center;
margin-left: auto;
margin-right: auto;
}
.code-sample {
white-space: pre;
}
/* Terminal backgrounds */
.terminal {
display: block;
width: 850px;
margin-left: auto;
margin-right: auto;
}
.terminal-titlebar {
background-color: #c0c0c0;
height: 30px;
border-top-left-radius: 5px;
border-top-right-radius: 5px;
}
.terminal-body {
background-color: #000;
color: #fff;
font-family: "Consolas", "Monaco", monospace;
font-size: 16px;
font-weight: bold;
padding: 15px;
text-align: left;
height: auto;
overflow: auto;
word-wrap: break-word;
border-bottom-left-radius: 5px;
border-bottom-right-radius: 5px;
}
.prompt {
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
color: #c0c0c0;
}
.windows-prompt:after {
content: 'PS > ';
}
.unix-prompt:after {
content: '~$ ';
}
@media (max-device-width: 480px) and (orientation: portrait), (max-device-width: 700px) and (orientation: landscape){
/* Index page overrides */
.btn-hero-core {
padding: 10px 15px;
margin-left: 0px;
font-size: 16px;
}
.intro-image > img {
display: none;
}
/* Overview overrides */
img[src*="10kft_view"] {
width: 100%;
height: 100%;
}
/* Getting started overrides */
.btn-gs {
width: auto;
}
.btn-gs:hover, .btn-gs:active, .btn-gs:focus, .jquery-active {
width: auto;
}
.step {
width: 90%;
font-size: 14px;
}
.step > h3 {
font-size: 24px;
}
.step-number {
width: 40px;
font-size: 18px;
padding: 5px;
}
.terminal {
width: 95%;
}
.terminal-titlebar {
height: 20px;
}
.terminal-body {
font-size: 12px;
padding: 5px;
}
}

43
docs/template/styles/style.css vendored Normal file
View File

@@ -0,0 +1,43 @@
body {
font-family: "Open Sans", "Segoe UI", sans-serif;
padding-top: 0px;
}
footer {
z-index: 0;
}
.navbar-brand {
font-size: 18px;
padding: 15px;
}
.toc .level3 {
font-weight: normal;
margin-top: 5px;
margin-left: 10px;
}
a.pull-right {
margin-left: 10px;
padding-top: 5px;
}
article.content > h1 {
word-break: break-word;
}
@media only screen and (max-width: 768px) {
.toc .level3 > li {
display: inline-block;
}
.toc .level3 > li:after {
margin-left: -3px;
margin-right: 5px;
content: ", ";
color: #666666;
}
}
@media (max-width: 260px) {
.toc .level3 > li {
display: block;
}
.toc .level3 > li:after {
display: none;
}
}