Skip to content

Commit 4fe3583

Browse files
kMutagenekMutagene
committed
Init fslab themed documentation
1 parent 092c44e commit 4fe3583

File tree

10 files changed

+9462
-9
lines changed

10 files changed

+9462
-9
lines changed

‎.config/dotnet-tools.json

+6
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
"commands": [
88
"fake"
99
]
10+
},
11+
"fsharp.formatting.commandtool": {
12+
"version": "8.0.1",
13+
"commands": [
14+
"fsdocs"
15+
]
1016
}
1117
}
1218
}

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -359,4 +359,6 @@ MigrationBackup/
359359
.ionide/
360360

361361
# Fody - auto-generated XML schema
362-
FodyWeavers.xsd
362+
FodyWeavers.xsd
363+
tmp/watch
364+
.fsdocs/cache

‎Dash.NET.sln

+39-6
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ VisualStudioVersion = 16.0.30320.27
55
MinimumVisualStudioVersion = 15.0.26124.0
66
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_project", "_project", "{625E3CAC-600B-450D-BF54-E3059450591A}"
77
ProjectSection(SolutionItems) = preProject
8+
build.cmd = build.cmd
89
build.fsx = build.fsx
10+
build.sh = build.sh
911
.config\dotnet-tools.json = .config\dotnet-tools.json
10-
fake.cmd = fake.cmd
11-
fake.sh = fake.sh
1212
global.json = global.json
1313
dev\Properties\launchSettings.json = dev\Properties\launchSettings.json
1414
README.md = README.md
@@ -21,7 +21,37 @@ Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Dash.NET.Dev", "dev\Dash.NE
2121
EndProject
2222
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{8531DA15-1690-4671-8741-89C4953163C6}"
2323
EndProject
24-
Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Dash.NET.Tests", "tests\Dash.NET.Tests\Dash.NET.Tests.fsproj", "{ECDBA25E-39B4-4C59-B665-0695F50A51BF}"
24+
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Dash.NET.Tests", "tests\Dash.NET.Tests\Dash.NET.Tests.fsproj", "{ECDBA25E-39B4-4C59-B665-0695F50A51BF}"
25+
EndProject
26+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{420D4858-5F4C-45FE-BD17-818FDB1E94ED}"
27+
ProjectSection(SolutionItems) = preProject
28+
docs\_template.html = docs\_template.html
29+
docs\_template.ipynb = docs\_template.ipynb
30+
docs\index.fsx = docs\index.fsx
31+
EndProjectSection
32+
EndProject
33+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "img", "img", "{EBDFED69-A812-46BC-80E8-5D7DCFED71FE}"
34+
ProjectSection(SolutionItems) = preProject
35+
docs\img\callback.gif = docs\img\callback.gif
36+
docs\img\favicon.ico = docs\img\favicon.ico
37+
docs\img\hello-graph.png = docs\img\hello-graph.png
38+
docs\img\hello-world-bulma.png = docs\img\hello-world-bulma.png
39+
docs\img\hello-world-green.png = docs\img\hello-world-green.png
40+
docs\img\hello-world.png = docs\img\hello-world.png
41+
docs\img\logo.png = docs\img\logo.png
42+
docs\img\logo_title.svg = docs\img\logo_title.svg
43+
docs\img\state.gif = docs\img\state.gif
44+
EndProjectSection
45+
EndProject
46+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reference", "reference", "{C93A091D-58DB-4896-A9DA-1016011A6494}"
47+
ProjectSection(SolutionItems) = preProject
48+
docs\reference\_template.html = docs\reference\_template.html
49+
EndProjectSection
50+
EndProject
51+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{ED23F221-EFE6-4538-BEA2-A6A4F806FDDF}"
52+
ProjectSection(SolutionItems) = preProject
53+
docs\content\fsdocs-custom.css = docs\content\fsdocs-custom.css
54+
EndProjectSection
2555
EndProject
2656
Global
2757
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -73,10 +103,13 @@ Global
73103
GlobalSection(SolutionProperties) = preSolution
74104
HideSolutionNode = FALSE
75105
EndGlobalSection
76-
GlobalSection(ExtensibilityGlobals) = postSolution
77-
SolutionGuid = {47D6A0E3-05A6-4BB7-81D1-A90CE758E430}
78-
EndGlobalSection
79106
GlobalSection(NestedProjects) = preSolution
80107
{ECDBA25E-39B4-4C59-B665-0695F50A51BF} = {8531DA15-1690-4671-8741-89C4953163C6}
108+
{EBDFED69-A812-46BC-80E8-5D7DCFED71FE} = {420D4858-5F4C-45FE-BD17-818FDB1E94ED}
109+
{C93A091D-58DB-4896-A9DA-1016011A6494} = {420D4858-5F4C-45FE-BD17-818FDB1E94ED}
110+
{ED23F221-EFE6-4538-BEA2-A6A4F806FDDF} = {420D4858-5F4C-45FE-BD17-818FDB1E94ED}
111+
EndGlobalSection
112+
GlobalSection(ExtensibilityGlobals) = postSolution
113+
SolutionGuid = {47D6A0E3-05A6-4BB7-81D1-A90CE758E430}
81114
EndGlobalSection
82115
EndGlobal

‎fake.cmd renamed to ‎build.cmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
dotnet tool restore
2-
dotnet fake %*
2+
dotnet fake build %*

‎fake.sh renamed to ‎build.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ set -eu
44
set -o pipefail
55

66
dotnet tool restore
7-
dotnet fake "$@"
7+
dotnet fake build "$@"

‎docs/_template.html

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
4+
<head>
5+
<meta charset="utf-8">
6+
<title>{{fsdocs-page-title}}</title>
7+
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
8+
<meta name="author" content="{{fsdocs-authors}}">
9+
<link rel="shortcut icon" type="image/x-icon" href="{{root}}/img/favicon.ico">
10+
<script src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
11+
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
12+
<!-- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script> -->
13+
14+
<link type="text/css" rel="stylesheet" href="{{root}}content/fsdocs-default.css" />
15+
<link type="text/css" rel="stylesheet" href="{{root}}content/fsdocs-custom.css" />
16+
<script type="text/javascript" src="{{root}}content/fsdocs-tips.js"></script>
17+
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
18+
<!--[if lt IE 9]>
19+
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
20+
<![endif]-->
21+
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
22+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />
23+
<!-- END SEARCH BOX: this adds support for the search box -->
24+
{{fsdocs-watch-script}}
25+
</head>
26+
27+
<body>
28+
<div class="columns is-fullheight m-0">
29+
<div id="fsdocs-menu" class="column is-2 is-paddingless">
30+
<aside class="menu">
31+
<div class="container is-paddingless is-marginless has-background-dark">
32+
<a href="{{fsdocs-logo-link}}">
33+
<figure class="image is-128x128 container">
34+
<img src="{{fsdocs-logo-src}}">
35+
</figure>
36+
</a>
37+
<h2 class="title has-text-centered has-text-white">{{fsdocs-collection-name}}</h2>
38+
<h5 class="has-text-centered has-text-white pb-4">Documentation for {{fsdocs-package-version}}</h5>
39+
</div>
40+
<div class="content">
41+
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
42+
<div id="header">
43+
<div class="searchbox" id="fsdocs-searchbox">
44+
<label for="search-by">
45+
<i class="fas fa-search"></i>
46+
</label>
47+
<input data-search-input="" id="search-by" type="search" placeholder="Search..." class="input"/>
48+
<span data-search-clear="">
49+
<i class="fas fa-times"></i>
50+
</span>
51+
</div>
52+
</div>
53+
<!-- END SEARCH BOX: this adds support for the search box -->
54+
<ul class="navbar-nav">
55+
<li class="nav-header">Links</li>
56+
<li class="nav-item" id="fsdocs-license-link"><a class="nav-link" href="{{fsdocs-license-link}}">License (MIT)</a></li>
57+
<li class="nav-item" id="fsdocs-release-notes-link"><a class="nav-link" href="{{fsdocs-release-notes-link}}">Release Notes</a></li>
58+
<li class="nav-item" id="fsdocs-repository-link"><a class="nav-link" href="{{fsdocs-repository-link}}">Source Repository</a></li>
59+
{{fsdocs-list-of-documents}}
60+
61+
62+
63+
</ul>
64+
</div>
65+
</aside>
66+
</div>
67+
<div class="column is-10 is-paddingless">
68+
<div class="section pt-4">
69+
<div class="container" id="fsdocs-content">
70+
{{fsdocs-content}}
71+
</div>
72+
</div>
73+
</div>
74+
{{fsdocs-tooltips}}
75+
</div>
76+
77+
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
78+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />
79+
<script type="text/javascript">var fsdocs_search_baseurl = '{{root}}'</script>
80+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.8/lunr.min.js"></script>
81+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.min.js"></script>
82+
<script type="text/javascript" src="{{root}}content/fsdocs-search.js"></script>
83+
<!-- END SEARCH BOX: this adds support for the search box -->
84+
</body>
85+
86+
</html>

0 commit comments

Comments
 (0)