Skip to content

Commit

Permalink
implement DocFX
Browse files Browse the repository at this point in the history
  • Loading branch information
@saucecontrol
saucecontrol committed Jan 6, 2020
1 parent e5537b0 commit d8d1896
Show file tree
Hide file tree
Showing 7 changed files with 381 additions and 578 deletions.
45 changes: 45 additions & 0 deletions doc/docfx.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"metadata": [
{
"src": [
{
"src": "../",
"files": [
"out/bin/MagicScaler/Dist/**\/PhotoSauce.MagicScaler.dll"
]
}
],
"dest": "../out/doc/api",
"properties": {
"TargetFramework": "netcoreapp3.0",
"Configuration": "Dist"
}
}
],
"build": {
"content": [
{
"src": "../out/doc",
"files": "api/**.yml"
},
{
"files": [
"toc.yml",
"*.md"
]
}
],
"template": [ "default", "template" ],
"dest": "../out/doc/_site",
"intermediateFolder": "../out/obj/DocFX",
"markdownEngineName": "markdig",
"postProcessors": "ExtractSearchIndex",
"globalMetadata": {
"_appFooter": "<span>Copyright © 2020 Clinton Ingram<br>Generated with <strong>DocFX</strong></span>",
"_appTitle": "PhotoSauce Documentation",
"_enableSearch": true,
"_enableNewTab": false,
"_gitUrlPattern": "github"
}
}
}
3 changes: 3 additions & 0 deletions doc/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Welcome to the PhotoSauce documentation site!

The [MagicScaler API](/api/PhotoSauce.MagicScaler.html) and [WebRSize Configuration Guide](/web.html) are here, and there is more to come.
566 changes: 1 addition & 565 deletions doc/main.md
View file

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions doc/template/partials/head.tmpl.partial
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{{!Copyright (c) Oscar Vasquez. 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}}">
<meta name="generator" content="docfx {{_docfxVersion}}">
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.css">
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
<link rel="stylesheet" href="{{_rel}}styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="{{_navRel}}">
<meta property="docfx:tocrel" content="{{_tocRel}}">
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
{{#_enableSearch}}<meta property="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
{{#_enableNewTab}}<meta property="docfx:newtab" content="true">{{/_enableNewTab}}
</head>
280 changes: 280 additions & 0 deletions doc/template/styles/main.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,280 @@
/* COLOR VARIABLES*/
:root {
--primary-color: #0d47a1;
--primary-light: #5e92f3;
--primary-dark: #003c8f;
--font-color: #34393e;
}

body {
color: var(--font-color);
font-family: "Roboto", sans-serif;
line-height: 1.5;
font-size: 16px;
-ms-text-size-adjust: 100%;
-webkit-text-size-adjust: 100%;
word-wrap: break-word;
}

/* HIGHLIGHT COLOR */

button,
a {
color: var(--primary-dark);
cursor: pointer;
}

button:hover,
button:focus,
a:hover,
a:focus {
color: var(--primary-light);
text-decoration: none;
}

.toc .nav > li.active > a {
color: var(--primary-dark);
}

.toc .nav > li.active > a:hover,
.toc .nav > li.active > a:focus {
color: var(--primary-light);
}

.pagination > .active > a {
background-color: var(--primary-color);
border-color: var(--primary-color);
}

.pagination > .active > a,
.pagination > .active > a:focus,
.pagination > .active > a:hover,
.pagination > .active > span,
.pagination > .active > span:focus,
.pagination > .active > span:hover {
background-color: var(--primary-light);
border-color: var(--primary-light);
}

/* HEADINGS */

h1 {
font-weight: 600;
font-size: 32px;
}

h2 {
font-weight: 600;
font-size: 24px;
line-height: 1.8;
}

h3 {
font-weight: 600;
font-size: 20px;
line-height: 1.8;
}

h5 {
font-size: 14px;
padding: 10px 0px;
}

article h1,
article h2,
article h3,
article h4 {
margin-top: 35px;
margin-bottom: 15px;
}

article h4 {
padding-bottom: 8px;
border-bottom: 2px solid #ddd;
}

/* NAVBAR */

.navbar-brand > img {
color: #fff;
}

.navbar {
border: none;
/* Both navbars use box-shadow */
-webkit-box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
-moz-box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
}

.subnav {
border-top: 1px solid #ddd;
background-color: #fff;
}

.navbar-inverse {
background-color: var(--primary-color);
z-index: 100;
}

.navbar-inverse .navbar-nav > li > a,
.navbar-inverse .navbar-text {
color: #fff;
background-color: var(--primary-color);
border-bottom: 3px solid transparent;
padding-bottom: 12px;
}

.navbar-inverse .navbar-nav > li > a:focus,
.navbar-inverse .navbar-nav > li > a:hover {
color: #fff;
background-color: var(--primary-color);
border-bottom: 3px solid white;
}

.navbar-inverse .navbar-nav > .active > a,
.navbar-inverse .navbar-nav > .active > a:focus,
.navbar-inverse .navbar-nav > .active > a:hover {
color: #fff;
background-color: var(--primary-color);
border-bottom: 3px solid white;
}

.navbar-form .form-control {
border: none;
border-radius: 20px;
}

/* SIDEBAR */

.toc .level1 > li {
font-weight: 400;
}

.toc .level2 > li {
padding: 3px;
}

.toc .nav > li > a {
color: var(--font-color);
}

.sidefilter {
background-color: #fff;
border-left: none;
border-right: none;
}

.sidefilter {
background-color: #fff;
border-left: none;
border-right: none;
}

.toc-filter {
padding: 10px;
margin: 0;
}

.toc-filter > input {
border: 2px solid #ddd;
border-radius: 20px;
}

.toc-filter > .filter-icon {
display: none;
}

.toc-filter > .clear-icon {
top: 18px;
right: 18px;
}

.sidetoc > .toc {
background-color: #fff;
overflow-x: hidden;
}

.sidetoc {
background-color: #fff;
border: none;
}

/* ALERTS */

.alert {
padding: 0px 0px 5px 0px;
color: inherit;
background-color: inherit;
border: none;
box-shadow: 0px 2px 2px 0px rgba(100, 100, 100, 0.4);
}

.alert > p {
margin-bottom: 0;
padding: 5px 10px;
}

.alert > ul {
margin-bottom: 0;
padding: 5px 40px;
}

.alert > h5 {
padding: 10px 15px;
margin-top: 0;
text-transform: uppercase;
font-weight: bold;
border-radius: 4px 4px 0 0;
}

.alert-info > h5 {
color: #1976d2;
border-bottom: 4px solid #1976d2;
background-color: #e3f2fd;
}

.alert-warning > h5 {
color: #f57f17;
border-bottom: 4px solid #f57f17;
background-color: #fff3e0;
}

.alert-danger > h5 {
color: #d32f2f;
border-bottom: 4px solid #d32f2f;
background-color: #ffebee;
}

/* CODE HIGHLIGHT */
pre {
padding: 9.5px;
margin: 1rem 0;
font-size: 13px;
word-break: break-all;
word-wrap: break-word;
background-color: #fafafe;
border-radius: 4px;
box-shadow: 0px 1px 4px 1px rgba(100, 100, 100, 0.4);
}

.markdown span.xref {
font-family: Menlo,Monaco,Consolas,"Courier New",monospace;
font-size: 90%;
background-color: #fafafa;
padding: 2px 4px;
border-radius: 4px
}

p + p, p + hr, p + ol, p + ul, p + .alert, pre + p {
margin-top: 2rem;
}

.contribution > .nav > li:first-of-type { display: none; }
.pull-right.mobile-hide { display: none; }

@media only screen and (min-width: 768px) {
.pull-right.mobile-hide + .pull-right.mobile-hide {
display: block;
}
}
6 changes: 6 additions & 0 deletions doc/toc.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- name: MagicScaler API
topicUid: PhotoSauce.MagicScaler
- name: WebRSize
href: web.md
- name: GitHub
href: https://github.com/saucecontrol/PhotoSauce
Loading

0 comments on commit d8d1896

Please sign in to comment.