mirror of
https://github.com/overte-org/overte.git
synced 2025-08-08 17:17:58 +02:00
Add markdeep for docs
This commit is contained in:
sabrina-shanman
parent
237022d304
commit
a5950156cc
4 changed files with 224 additions and 0 deletions
24
docs/LICENSE_highlight.js.txt
Normal file
24
docs/LICENSE_highlight.js.txt
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
Copyright (c) 2006, Ivan Sagalaev
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification, are
|
||||||
|
permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright notice, this list of
|
||||||
|
conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above copyright notice, this list
|
||||||
|
of conditions and the following disclaimer in the documentation and/or other materials
|
||||||
|
provided with the distribution.
|
||||||
|
* Neither the name of highlight.js nor the names of its contributors may be used to
|
||||||
|
endorse or promote products derived from this software without specific prior written
|
||||||
|
permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
|
||||||
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||||
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||||
|
THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
||||||
|
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||||
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
|
||||||
|
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||||
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
23
docs/LICENSE_markdeep.txt
Normal file
23
docs/LICENSE_markdeep.txt
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
Copyright 2015-2017, Morgan McGuire
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification,
|
||||||
|
are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer in the documentation and/or other
|
||||||
|
materials provided with the distribution.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||||
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||||
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||||||
|
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
||||||
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||||
|
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||||
|
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
||||||
|
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
||||||
|
THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
7
docs/markdeep.min.js
vendored
Normal file
7
docs/markdeep.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
170
docs/markdeep_apidoc.css
Normal file
170
docs/markdeep_apidoc.css
Normal file
|
|
@ -0,0 +1,170 @@
|
||||||
|
/* Custom stylesheet for API documentation by Aras Pranckevičius, http://aras-p.info/
|
||||||
|
and tweaked by Morgan McGuire.
|
||||||
|
Licensed as public domain or BSD 2-clause, whichever is more convenient for you.
|
||||||
|
Originally from https://github.com/aras-p/markdeep-docs-style */
|
||||||
|
body {
|
||||||
|
max-width: 50em;
|
||||||
|
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||||
|
text-align: left;
|
||||||
|
margin: 1.5em;
|
||||||
|
padding: 0 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* if screen is wide enough, put table of contents on the right side */
|
||||||
|
@media screen and (min-width: 64em) {
|
||||||
|
.md .longTOC, .md .mediumTOC, .md .shortTOC {
|
||||||
|
max-width: 20em;
|
||||||
|
left: 54em;
|
||||||
|
display:block;
|
||||||
|
position: fixed;
|
||||||
|
top:0;
|
||||||
|
bottom:0;
|
||||||
|
overflow-y:scroll;
|
||||||
|
margin-top:0;
|
||||||
|
margin-bottom:0;
|
||||||
|
padding-top:1em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* for narrow screens or print, hide table of contents */
|
||||||
|
@media screen and (max-width: 64em) {
|
||||||
|
.md .longTOC, .md .mediumTOC, .md .shortTOC { display: none; }
|
||||||
|
}
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
.md .longTOC, .md .mediumTOC, .md .shortTOC { display: none; }
|
||||||
|
body { max-width: 100%; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/* reset heading/link fonts to that of body */
|
||||||
|
.md a,
|
||||||
|
.md div.title, contents, .md .tocHeader,
|
||||||
|
.md h1, .md h2, .md h3, .md h4, .md h5, .md h6,
|
||||||
|
.md .nonumberh1, .md .nonumberh2, .md .nonumberh3, .md .nonumberh4, .md .nonumberh5, .md .nonumberh6,
|
||||||
|
.md .shortTOC, .md .mediumTOC, .md .longTOC {
|
||||||
|
font-family: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md div.title {
|
||||||
|
margin: 0.4em 0 0 0;
|
||||||
|
padding: 0;
|
||||||
|
text-align: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md div.subtitle {
|
||||||
|
text-align: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* faint border below headings */
|
||||||
|
.md h1, .md h2, .md h3, .md h4,
|
||||||
|
.md .nonumberh1, .md .nonumberh2, .md .nonumberh3, .md .nonumberh4 {
|
||||||
|
border-bottom: 1px solid rgba(0,0,0,.1);
|
||||||
|
}
|
||||||
|
/* heading font styles */
|
||||||
|
.md h1, .md .nonumberh1, .md div.title {
|
||||||
|
font-size: 150%;
|
||||||
|
font-weight: 600;
|
||||||
|
color: rgba(0,0,0,.7);
|
||||||
|
}
|
||||||
|
.md h2, .md .nonumberh2 {
|
||||||
|
font-size: 120%;
|
||||||
|
font-weight: 400;
|
||||||
|
color: rgba(0,0,0,.9);
|
||||||
|
}
|
||||||
|
.md h3, .md .nonumberh3 {
|
||||||
|
font-size: 110%;
|
||||||
|
font-weight: 400;
|
||||||
|
color: rgba(0,0,0,.7);
|
||||||
|
}
|
||||||
|
/* no numbering of headings */
|
||||||
|
.md h1:before, .md h2:before, .md h3:before, .md h4:before { content: none; }
|
||||||
|
|
||||||
|
/* link styling */
|
||||||
|
.md a:link, .md a:visited {
|
||||||
|
color: #3f51b5;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* inline and block code */
|
||||||
|
.md code, .md pre.listing {
|
||||||
|
background-color: rgba(0,0,0,.05);
|
||||||
|
padding: 0.1em 0.2em;
|
||||||
|
border-radius: 0.15em;
|
||||||
|
}
|
||||||
|
.md pre.listing code {
|
||||||
|
background-color: transparent;
|
||||||
|
padding: 0;
|
||||||
|
border: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* table of contents styling; make all 3 forms of it look the same */
|
||||||
|
.md .longTOC, .md .mediumTOC, .md .shortTOC {
|
||||||
|
font-size: inherit;
|
||||||
|
line-height: 120%;
|
||||||
|
margin: 1em 0;
|
||||||
|
padding: .4rem;
|
||||||
|
border-left: .1rem solid #3f51b5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .tocHeader {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
border: none;
|
||||||
|
font-size: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .tocNumber {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .longTOC .level1, .md .mediumTOC .level1, .md .shortTOC .level1 {
|
||||||
|
font-weight: inherit;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .longTOC p, .md .mediumTOC p, .md .shortTOC p {
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .longTOC center, .md .mediumTOC center, .md .shortTOC center, .md .tocHeader {
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .longTOC b, .md .mediumTOC b, .md .shortTOC b {
|
||||||
|
font-weight: 400;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .longTOC center b, .md .mediumTOC center b, .md .shortTOC center b {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .longTOC a, .md .mediumTOC a, .md .shortTOC a {
|
||||||
|
color: black;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md .longTOC .level1, .md .mediumTOC .level1, .md .shortTOC .level1,
|
||||||
|
.md .longTOC .level2, .md .mediumTOC .level2, .md .shortTOC .level2,
|
||||||
|
.md .longTOC .level3, .md .mediumTOC .level3, .md .shortTOC .level3 {
|
||||||
|
white-space: nowrap;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
font-size: 90%;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* tables; use fainter colors than regular markdeep style */
|
||||||
|
.md table.table {
|
||||||
|
font-size: 90%;
|
||||||
|
}
|
||||||
|
.md table.table th {
|
||||||
|
border: none;
|
||||||
|
background-color: #ccc;
|
||||||
|
color: rgba(0,0,0,.6);
|
||||||
|
}
|
||||||
|
.md table.table tr, .md table.table td {
|
||||||
|
border-color: #eee;
|
||||||
|
}
|
||||||
|
.md table.table tr:nth-child(even) {
|
||||||
|
background-color: #f4f4f4;
|
||||||
|
}
|
||||||
|
|
||||||
Loading…
Reference in a new issue