Skip to content

Commit 2f14eee

Browse files
fugerit79fugerit79
committed
Adding docgen
1 parent 1c3b10e commit 2f14eee

20 files changed

+340
-0
lines changed

‎docgen/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.html
2+
/output/

‎docgen/contents.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[
2+
{
3+
"heading" : "Documentation for project Jupiter (Fugerit Core A.P.I.)",
4+
"column" : 1,
5+
"pages" : [
6+
{
7+
"title": "Jupiter Overview",
8+
"source": "index.md"
9+
}
10+
]
11+
}
12+
]

‎docgen/files/images/logo.png‎

Loading

‎docgen/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Documentation for project Jupiter (Fugerit Core A.P.I.) #
2+
3+
# Table of Contents
4+
5+
[Repository Git](https://github.com/fugerit-org/fj-lib)

‎docgen/package-lock.json‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docgen/parameters.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"title" : "Jupiter (Fugerit Core A.P.I.)",
3+
"name": "Jupiter",
4+
"version" : "0.6.5.13",
5+
"date" : "05/03/2020",
6+
"organization" : {
7+
"name" : "Fugerit Org",
8+
"url" : "https://www.fugerit.org"
9+
},
10+
"author" : {
11+
"name" : "Matteo a.k.a. Fugerit79",
12+
"url" : "https://github.com/fugerit79"
13+
},
14+
"owner" : {
15+
"name" : "Matteo a.k.a. Fugerit79",
16+
"url" : "https://github.com/fugerit79"
17+
},
18+
"contributors" : [
19+
{
20+
"name" : "Daneel",
21+
"url" : "https://github.com/daneeldeveloper"
22+
}
23+
],
24+
"website" : {
25+
"name" : "Jupiter Git Repository",
26+
"url" : "https://github.com/fugerit-org/fj-lib"
27+
},
28+
"backlink" : {
29+
"name" : "Mars Home Page",
30+
"url" : "https://www.fugerit.org/perm/jupiter/"
31+
},
32+
"module" : "Jupiter",
33+
"id" : "F001",
34+
"summary" : "Provides helper libraries for other java projects (io, configuration, etc.).",
35+
"marking" : "",
36+
"legalese" : ""
37+
}

‎docgen/release-notes.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
0.3.4.12
2+
--------
3+
Added documentation using [DocGen](http://mtmacdonald.github.io/docgen/docs/index.html).

‎docgen/require/docgen.css‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
pre {
2+
font-size: 12px; /*todo - move to webknife*/
3+
}
4+
5+
section blockquote p, section li p {
6+
margin: 0;
7+
}
8+
9+
.w-table {
10+
width: 100%;
11+
}
12+
13+
/******************************** TABLE OF CONTENTS ****************************/
14+
15+
/*Table of contents button to initiate show/hide*/
16+
#dg-navigator
17+
{
18+
float: right;
19+
background-color: #4d4d4d;
20+
color: white;
21+
text-align:right;
22+
padding: 10px 20px 10px 20px;
23+
margin-right: 200px;
24+
border-radius: 0 0 10px 10px;
25+
cursor: pointer;
26+
font-weight: bold;
27+
}
28+
29+
/*Table of contents container*/
30+
#dg-toc {
31+
color: white;
32+
background-color: #4d4d4d;
33+
}
34+
35+
#dg-toc table {
36+
table-layout: auto;
37+
width: 100%;
38+
}
39+
40+
#dg-toc div {
41+
padding: 15px 0 15px 0;
42+
}
43+
44+
/*Columns in table of contents*/
45+
46+
#dg-toc td {
47+
border-right: 1px solid #666;
48+
vertical-align: top;
49+
text-align: left;
50+
padding: 0 20px 0 20px;
51+
}
52+
53+
#dg-toc ul {
54+
padding: 0;
55+
list-style-type: none;
56+
}
57+
58+
#dg-toc li {
59+
font-weight: bold;
60+
}
61+
62+
#dg-toc table td a {
63+
color: white;
64+
font-weight: normal;
65+
text-decoration: none;
66+
margin-left: 10px;
67+
}
68+
69+
#dg-toc table td a:hover {
70+
text-decoration: underline;
71+
}
72+
73+
#dg-tocFixedColumn {
74+
border-right: none;
75+
}
76+
77+
#dg-toc table #dg-tocFixedColumn a {
78+
vertical-align: middle;
79+
margin-left: 4px;
80+
}
81+
82+
.dg-tocGroup {
83+
width: 22%;
84+
}
85+
86+
.dg-tocHeading {
87+
font-size: 16px;
88+
}
89+
90+
.dg-tocIcon {width: 18px; height: 18px; float: left;}
91+
.dg-tocIcon svg {fill: white;}
92+
93+
/*
94+
Page table of contents
95+
*/
96+
97+
.dg-pageToc {
98+
list-style: none;
99+
padding: 10px;
100+
border: 1px solid #999;
101+
background-color: #eee;
102+
}
103+
104+
/*
105+
Class to make a heading look invisible in web page, but still appear in the PDF table of contents
106+
- display:none, visibily: hidden, zero dimensions, and offscreen positioning don't work
107+
- so instead take it out of the flow and make it small and translucent
108+
*/
109+
110+
.dg-hiddenTitle {
111+
display: block;
112+
border: none;
113+
margin: 0;
114+
padding: 0;
115+
width: 1px;
116+
height: 1px;
117+
overflow: hidden;
118+
position: absolute;
119+
background-color: transparent;
120+
}
121+
122+
.dg-fakeHeading { /*todo - move to webknife*/
123+
text-decoration:none;
124+
font-weight: bold;
125+
color: #385691;
126+
padding-bottom: 5px;
127+
border-bottom: 1px solid #999;
128+
margin: 20px 0 20px 0;
129+
font-size: 16px;
130+
padding-bottom: 4px;
131+
}

‎docgen/require/katexInjector.js‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
$(document).ready( function () {
3+
4+
//mathematical expressions using katex, if enabled
5+
$('.dg-katexMath').each(function() {
6+
var texTxt = $(this).text();
7+
8+
el = $(this).get(0);
9+
if(el.tagName == "DIV"){
10+
addDisp = "\\displaystyle";
11+
} else {
12+
addDisp = "";
13+
}
14+
try {
15+
katex.render(addDisp+texTxt, el);
16+
}
17+
catch(err) {
18+
$(this).html("<span class='err'>"+err);
19+
}
20+
});
21+
22+
});

‎docgen/require/print.css‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
html {
2+
background-color :white; /*otherwise background artefacts appear as a feint outline in PDF*/
3+
}
4+
5+
.dg-pageToc {
6+
display: none;
7+
}
8+
9+
#dg-toc, #dg-navigator, header, footer {
10+
display: none;
11+
}
12+
13+
.dg-avoidBreak, #dg-content th, #dg-content tr, #dg-content blockquote, #dg-content pre {
14+
page-break-inside: avoid;
15+
}
16+
17+
.dg-forceBreak {
18+
page-break-after: always;
19+
}

0 commit comments

Comments
 (0)