Skip to content

Commit d8d1896

Browse files
saucecontrolsaucecontrol
committed
implement DocFX
1 parent e5537b0 commit d8d1896

File tree

7 files changed

+381
-578
lines changed

7 files changed

+381
-578
lines changed

‎doc/docfx.json‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"metadata": [
3+
{
4+
"src": [
5+
{
6+
"src": "../",
7+
"files": [
8+
"out/bin/MagicScaler/Dist/**\/PhotoSauce.MagicScaler.dll"
9+
]
10+
}
11+
],
12+
"dest": "../out/doc/api",
13+
"properties": {
14+
"TargetFramework": "netcoreapp3.0",
15+
"Configuration": "Dist"
16+
}
17+
}
18+
],
19+
"build": {
20+
"content": [
21+
{
22+
"src": "../out/doc",
23+
"files": "api/**.yml"
24+
},
25+
{
26+
"files": [
27+
"toc.yml",
28+
"*.md"
29+
]
30+
}
31+
],
32+
"template": [ "default", "template" ],
33+
"dest": "../out/doc/_site",
34+
"intermediateFolder": "../out/obj/DocFX",
35+
"markdownEngineName": "markdig",
36+
"postProcessors": "ExtractSearchIndex",
37+
"globalMetadata": {
38+
"_appFooter": "<span>Copyright © 2020 Clinton Ingram<br>Generated with <strong>DocFX</strong></span>",
39+
"_appTitle": "PhotoSauce Documentation",
40+
"_enableSearch": true,
41+
"_enableNewTab": false,
42+
"_gitUrlPattern": "github"
43+
}
44+
}
45+
}

‎doc/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Welcome to the PhotoSauce documentation site!
2+
3+
The [MagicScaler API](/api/PhotoSauce.MagicScaler.html) and [WebRSize Configuration Guide](/web.html) are here, and there is more to come.

‎doc/main.md‎

Lines changed: 1 addition & 565 deletions
Large diffs are not rendered by default.

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{{!Copyright (c) Oscar Vasquez. 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+
<meta name="generator" content="docfx {{_docfxVersion}}">
10+
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
11+
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
12+
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.css">
13+
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
14+
<link rel="stylesheet" href="{{_rel}}styles/main.css">
15+
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
16+
<meta property="docfx:navrel" content="{{_navRel}}">
17+
<meta property="docfx:tocrel" content="{{_tocRel}}">
18+
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
19+
{{#_enableSearch}}<meta property="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
20+
{{#_enableNewTab}}<meta property="docfx:newtab" content="true">{{/_enableNewTab}}
21+
</head>

‎doc/template/styles/main.css‎

Lines changed: 280 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,280 @@
1+
/* COLOR VARIABLES*/
2+
:root {
3+
--primary-color: #0d47a1;
4+
--primary-light: #5e92f3;
5+
--primary-dark: #003c8f;
6+
--font-color: #34393e;
7+
}
8+
9+
body {
10+
color: var(--font-color);
11+
font-family: "Roboto", sans-serif;
12+
line-height: 1.5;
13+
font-size: 16px;
14+
-ms-text-size-adjust: 100%;
15+
-webkit-text-size-adjust: 100%;
16+
word-wrap: break-word;
17+
}
18+
19+
/* HIGHLIGHT COLOR */
20+
21+
button,
22+
a {
23+
color: var(--primary-dark);
24+
cursor: pointer;
25+
}
26+
27+
button:hover,
28+
button:focus,
29+
a:hover,
30+
a:focus {
31+
color: var(--primary-light);
32+
text-decoration: none;
33+
}
34+
35+
.toc .nav > li.active > a {
36+
color: var(--primary-dark);
37+
}
38+
39+
.toc .nav > li.active > a:hover,
40+
.toc .nav > li.active > a:focus {
41+
color: var(--primary-light);
42+
}
43+
44+
.pagination > .active > a {
45+
background-color: var(--primary-color);
46+
border-color: var(--primary-color);
47+
}
48+
49+
.pagination > .active > a,
50+
.pagination > .active > a:focus,
51+
.pagination > .active > a:hover,
52+
.pagination > .active > span,
53+
.pagination > .active > span:focus,
54+
.pagination > .active > span:hover {
55+
background-color: var(--primary-light);
56+
border-color: var(--primary-light);
57+
}
58+
59+
/* HEADINGS */
60+
61+
h1 {
62+
font-weight: 600;
63+
font-size: 32px;
64+
}
65+
66+
h2 {
67+
font-weight: 600;
68+
font-size: 24px;
69+
line-height: 1.8;
70+
}
71+
72+
h3 {
73+
font-weight: 600;
74+
font-size: 20px;
75+
line-height: 1.8;
76+
}
77+
78+
h5 {
79+
font-size: 14px;
80+
padding: 10px 0px;
81+
}
82+
83+
article h1,
84+
article h2,
85+
article h3,
86+
article h4 {
87+
margin-top: 35px;
88+
margin-bottom: 15px;
89+
}
90+
91+
article h4 {
92+
padding-bottom: 8px;
93+
border-bottom: 2px solid #ddd;
94+
}
95+
96+
/* NAVBAR */
97+
98+
.navbar-brand > img {
99+
color: #fff;
100+
}
101+
102+
.navbar {
103+
border: none;
104+
/* Both navbars use box-shadow */
105+
-webkit-box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
106+
-moz-box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
107+
box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
108+
}
109+
110+
.subnav {
111+
border-top: 1px solid #ddd;
112+
background-color: #fff;
113+
}
114+
115+
.navbar-inverse {
116+
background-color: var(--primary-color);
117+
z-index: 100;
118+
}
119+
120+
.navbar-inverse .navbar-nav > li > a,
121+
.navbar-inverse .navbar-text {
122+
color: #fff;
123+
background-color: var(--primary-color);
124+
border-bottom: 3px solid transparent;
125+
padding-bottom: 12px;
126+
}
127+
128+
.navbar-inverse .navbar-nav > li > a:focus,
129+
.navbar-inverse .navbar-nav > li > a:hover {
130+
color: #fff;
131+
background-color: var(--primary-color);
132+
border-bottom: 3px solid white;
133+
}
134+
135+
.navbar-inverse .navbar-nav > .active > a,
136+
.navbar-inverse .navbar-nav > .active > a:focus,
137+
.navbar-inverse .navbar-nav > .active > a:hover {
138+
color: #fff;
139+
background-color: var(--primary-color);
140+
border-bottom: 3px solid white;
141+
}
142+
143+
.navbar-form .form-control {
144+
border: none;
145+
border-radius: 20px;
146+
}
147+
148+
/* SIDEBAR */
149+
150+
.toc .level1 > li {
151+
font-weight: 400;
152+
}
153+
154+
.toc .level2 > li {
155+
padding: 3px;
156+
}
157+
158+
.toc .nav > li > a {
159+
color: var(--font-color);
160+
}
161+
162+
.sidefilter {
163+
background-color: #fff;
164+
border-left: none;
165+
border-right: none;
166+
}
167+
168+
.sidefilter {
169+
background-color: #fff;
170+
border-left: none;
171+
border-right: none;
172+
}
173+
174+
.toc-filter {
175+
padding: 10px;
176+
margin: 0;
177+
}
178+
179+
.toc-filter > input {
180+
border: 2px solid #ddd;
181+
border-radius: 20px;
182+
}
183+
184+
.toc-filter > .filter-icon {
185+
display: none;
186+
}
187+
188+
.toc-filter > .clear-icon {
189+
top: 18px;
190+
right: 18px;
191+
}
192+
193+
.sidetoc > .toc {
194+
background-color: #fff;
195+
overflow-x: hidden;
196+
}
197+
198+
.sidetoc {
199+
background-color: #fff;
200+
border: none;
201+
}
202+
203+
/* ALERTS */
204+
205+
.alert {
206+
padding: 0px 0px 5px 0px;
207+
color: inherit;
208+
background-color: inherit;
209+
border: none;
210+
box-shadow: 0px 2px 2px 0px rgba(100, 100, 100, 0.4);
211+
}
212+
213+
.alert > p {
214+
margin-bottom: 0;
215+
padding: 5px 10px;
216+
}
217+
218+
.alert > ul {
219+
margin-bottom: 0;
220+
padding: 5px 40px;
221+
}
222+
223+
.alert > h5 {
224+
padding: 10px 15px;
225+
margin-top: 0;
226+
text-transform: uppercase;
227+
font-weight: bold;
228+
border-radius: 4px 4px 0 0;
229+
}
230+
231+
.alert-info > h5 {
232+
color: #1976d2;
233+
border-bottom: 4px solid #1976d2;
234+
background-color: #e3f2fd;
235+
}
236+
237+
.alert-warning > h5 {
238+
color: #f57f17;
239+
border-bottom: 4px solid #f57f17;
240+
background-color: #fff3e0;
241+
}
242+
243+
.alert-danger > h5 {
244+
color: #d32f2f;
245+
border-bottom: 4px solid #d32f2f;
246+
background-color: #ffebee;
247+
}
248+
249+
/* CODE HIGHLIGHT */
250+
pre {
251+
padding: 9.5px;
252+
margin: 1rem 0;
253+
font-size: 13px;
254+
word-break: break-all;
255+
word-wrap: break-word;
256+
background-color: #fafafe;
257+
border-radius: 4px;
258+
box-shadow: 0px 1px 4px 1px rgba(100, 100, 100, 0.4);
259+
}
260+
261+
.markdown span.xref {
262+
font-family: Menlo,Monaco,Consolas,"Courier New",monospace;
263+
font-size: 90%;
264+
background-color: #fafafa;
265+
padding: 2px 4px;
266+
border-radius: 4px
267+
}
268+
269+
p + p, p + hr, p + ol, p + ul, p + .alert, pre + p {
270+
margin-top: 2rem;
271+
}
272+
273+
.contribution > .nav > li:first-of-type { display: none; }
274+
.pull-right.mobile-hide { display: none; }
275+
276+
@media only screen and (min-width: 768px) {
277+
.pull-right.mobile-hide + .pull-right.mobile-hide {
278+
display: block;
279+
}
280+
}

‎doc/toc.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- name: MagicScaler API
2+
topicUid: PhotoSauce.MagicScaler
3+
- name: WebRSize
4+
href: web.md
5+
- name: GitHub
6+
href: https://github.com/saucecontrol/PhotoSauce

0 commit comments

Comments
 (0)