Skip to content

Commit 858d2cb

Browse files
AragasAragas
committed
Merge branch 'docs2'
2 parents 47659da + 6435d31 commit 858d2cb

File tree

11 files changed

+413
-12
lines changed

11 files changed

+413
-12
lines changed

‎docs/api/index.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
# API Reference
2-
3-
Welcome to PCLExt.FileStorage reference. To begin, select a namespace, then a class, from the table of contents on the left.
1+
# APIs
2+
The primary APIs are the IFile and IFolder interfaces. BaseFile and BaseFolder implements them as abstract classes.

‎docs/articles/getting_started.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# APIs
2-
The primary APIs are the IFile and IFolder interfaces. BaseFile and BaseFolder implements them as abstract classes.
1+
Empty.
2+
Please select an example.

‎docs/docfx.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@
3636
"obj/**",
3737
"_site/**"
3838
]
39-
}
39+
},
40+
{
41+
"files": "README.md",
42+
"src": ".."
43+
}
4044
],
4145
"resource": [
4246
{
@@ -70,7 +74,8 @@
7074
"globalMetadataFiles": [],
7175
"fileMetadataFiles": [],
7276
"template": [
73-
"default"
77+
"default",
78+
"template"
7479
],
7580
"postProcessors": [],
7681
"noLangKeyword": false,

‎docs/index.md‎

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,50 @@
1-
# This is the **HOMEPAGE**.
2-
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
3-
## Quick Start Notes:
4-
1. Add images to the *images* folder if the file is referencing an image.
1+
---
2+
title: Welcome to PCLExt.FileStorage website!
3+
documentType: index
4+
---
5+
<style type="text/css">
6+
footer{
7+
position: relative;
8+
}
9+
</style>
10+
11+
<div class="hero">
12+
<div class="wrap">
13+
<div class="text">
14+
<strong>PCLExt.FileStorage</strong>
15+
</div>
16+
<div class="minitext">
17+
PCLExt.FileStorage is a bait-and-switch library that was designed to implement a storage API in portable projects.
18+
</div>
19+
<div class="buttons-unit">
20+
<a href="https://github.com/PCLExt/PCLExt.FileStorage" class="button"><i class="glyphicon glyphicon-cloud"></i>View in Github</a>
21+
<a href="https://www.nuget.org/packages/PCLExt.FileStorage/" class="button"><i class="glyphicon glyphicon-globe"></i>Get on NuGet</a>
22+
</div>
23+
</div>
24+
</div>
25+
<div class="key-section">
26+
<div class="container">
27+
<div class="row">
28+
<div class="col-md-8 col-md-offset-2 text-center">
29+
<i class="glyphicon glyphicon-tree-deciduous"></i>
30+
<section>
31+
<h2>Origin</h2>
32+
<p class="lead">It was formely a basic fork of PCL Storage, but later formed it's own set of API's designed to ease use of files and folders in managed code. It has a more "OOP" approach, avoiding the use of static classes.</p>
33+
</section>
34+
</div>
35+
</div>
36+
</div>
37+
</div>
38+
<div class="counter-key-section">
39+
<div class="container">
40+
<div class="row">
41+
<div class="col-md-8 col-md-offset-2 text-center">
42+
<i class="glyphicon glyphicon-phone"></i>
43+
<section>
44+
<h2>Supported Frameworks</h2>
45+
<p class="lead">PCLExt.FileStorage supports .NET Framework 4.5, .NET Standard 2.0, Xamarin.iOS, Xamarin.Android, Xamarin.Mac and UWP.</p>
46+
</section>
47+
</div>
48+
</div>
49+
</div>
50+
</div>

‎docs/template/dashboard.html.liquid‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%}
2+
{% ref /^styles/.*/ -%}
3+
{% ref /^fonts/.*/ -%}
4+
{% ref favicon.ico -%}
5+
{% ref logo.svg -%}
6+
<!DOCTYPE html>
7+
<!--[if IE]><![endif]-->
8+
<html>
9+
{% include partials/head -%}
10+
<body data-spy="scroll" data-target="#affix">
11+
<style type="text/css">
12+
#template-container {
13+
display: flex;
14+
flex-direction: row;
15+
flex-wrap: wrap;
16+
clear: both;
17+
}
18+
.template-item {
19+
flex: 0 0 50%;
20+
display: block;
21+
padding: 16px;
22+
}
23+
.template-screenshot {
24+
position: relative;
25+
margin-bottom: 16px;
26+
padding-top: 60%;
27+
height: 0;
28+
}
29+
.template-screenshot-img {
30+
position: absolute;
31+
top: 0;
32+
width: 100%;
33+
height: auto;
34+
}
35+
.template-title {
36+
font-weight: 600;
37+
font-size: 1.1em;
38+
}
39+
</style>
40+
<div id="wrapper">
41+
<header>
42+
{% include partials/navbar -%}
43+
{% include partials/breadcrumb -%}
44+
</header>
45+
<div role="main" class="container body-content hide-when-search">
46+
{% include partials/toc -%}
47+
<div class="article row grid-right">
48+
<span class="pull-right mobile-hide">
49+
<a href="{{contributionLink}}" class="contribution-link">Add Your Own Template</a>
50+
</span>
51+
{{rawTitle}}
52+
{{conceptual}}
53+
{%- if templates -%}
54+
<ul id="template-container">
55+
{%- for template in templates -%}
56+
<li class="template-item">
57+
<div class="template-screenshot">
58+
<img src= "{{template.thumbnail}}" class="template-screenshot-img"/>
59+
</div>
60+
<a class="template-title" href="{{template.homepage}}">{{template.name}}</a>
61+
<p class="template-desc" >{{template.description}}</p>
62+
{%- if template.usage -%}
63+
<ul>
64+
{%- if template.usage.init -%}
65+
<li><span>Init:<code>{{template.usage.init | escape}}</code></span></li>
66+
{%- endif -%}
67+
{%- if template.usage.command -%}
68+
<li><span>In command:<code>{{template.usage.command | escape}}</code></span></li>
69+
{%- endif -%}
70+
{%- if template.usage.config -%}
71+
<li><span>In <c>docfx.json</c>:<code>{{template.usage.config | escape}}</code></span></li>
72+
{%- endif -%}
73+
</ul>
74+
{%- endif -%}
75+
</li>
76+
{%- endfor -%}
77+
</ul>
78+
{%- endif -%}
79+
</div>
80+
</div>
81+
{% include partials/footer -%}
82+
</div>
83+
{% include partials/scripts -%}
84+
</body>
85+
</html>

‎docs/template/index.html.tmpl‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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+
{{>partials/navbar}}
14+
</header>
15+
{{{conceptual}}}
16+
{{>partials/footer}}
17+
</div>
18+
{{>partials/scripts}}
19+
</body>
20+
</html>

‎docs/template/layout/_master.tmpl‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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+
{{!include(search-stopwords.json)}}
7+
<!DOCTYPE html>
8+
<!--[if IE]><![endif]-->
9+
<html>
10+
{{>partials/head}}
11+
<body data-spy="scroll" data-target="#affix">
12+
<div id="wrapper">
13+
<header>
14+
{{^_disableNavbar}}
15+
{{>partials/navbar}}
16+
{{/_disableNavbar}}
17+
{{^_disableBreadcrumb}}
18+
{{>partials/breadcrumb}}
19+
{{/_disableBreadcrumb}}
20+
</header>
21+
{{#_enableSearch}}
22+
<div class="container body-content">
23+
{{>partials/searchResults}}
24+
</div>
25+
{{/_enableSearch}}
26+
<div role="main" class="container body-content hide-when-search">
27+
{{^_disableToc}}
28+
{{>partials/toc}}
29+
<div class="article row grid-right">
30+
{{/_disableToc}}
31+
{{#_disableToc}}
32+
<div class="article row grid">
33+
{{/_disableToc}}
34+
{{#_disableAffix}}
35+
<div class="col-md-12">
36+
{{/_disableAffix}}
37+
{{^_disableAffix}}
38+
<div class="col-md-10">
39+
{{/_disableAffix}}
40+
<article class="content wrap" id="_content" data-uid="{{uid}}">
41+
{{!body}}
42+
<div id="disqus_thread"></div>
43+
<script>
44+
(function() { // DON'T EDIT BELOW THIS LINE
45+
var d = document, s = d.createElement('script');
46+
s.src = 'https://pclext-filestorage.disqus.com/embed.js';
47+
s.setAttribute('data-timestamp', +new Date());
48+
(d.head || d.body).appendChild(s);
49+
})();
50+
</script>
51+
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
52+
</article>
53+
</div>
54+
{{^_disableAffix}}
55+
{{>partials/affix}}
56+
{{/_disableAffix}}
57+
</div>
58+
</div>
59+
{{^_disableFooter}}
60+
{{>partials/footer}}
61+
{{/_disableFooter}}
62+
</div>
63+
{{>partials/scripts}}
64+
</body>
65+
</html>

‎docs/template/partials/affix.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+
<div class="hidden-sm col-md-2" role="complementary">
4+
<div class="sideaffix">
5+
{{^_disableContribution}}
6+
<div class="contribution">
7+
<ul class="nav">
8+
{{#docurl}}
9+
<li>
10+
<a href="{{docurl}}" class="contribution-link">{{__global.improveThisDoc}}</a>
11+
</li>
12+
{{/docurl}}
13+
{{#sourceurl}}
14+
<li>
15+
<a href="{{sourceurl}}" class="contribution-link">{{__global.viewSource}}</a>
16+
</li>
17+
{{/sourceurl}}
18+
<li>
19+
<a href="#disqus_thread" class="contribution-link">0 Comments</a>
20+
</li>
21+
</ul>
22+
</div>
23+
{{/_disableContribution}}
24+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
25+
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
26+
</nav>
27+
</div>
28+
</div>

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
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+
<script type="text/javascript" src="{{_rel}}styles/docfx.vendor.js"></script>
4+
<script type="text/javascript" src="{{_rel}}styles/docfx.js"></script>
5+
<script type="text/javascript" src="{{_rel}}styles/main.js"></script>
6+
<script id="dsq-count-scr" src="//pclext-filestorage.disqus.com/count.js" async></script>

0 commit comments

Comments
 (0)