Skip to content

Commit db15c53

Browse files
dsymedsyme
authored
Merge pull request #42 from dsyme/f7
Bring up to latest F# Formatting master
2 parents 08858b3 + 8cc8129 commit db15c53

11 files changed

+210
-339
lines changed

‎.github/workflows/docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
- name: Build FSharp.Formatting master
3434
run: cd FSharp.Formatting && .\build -t Build
3535
- name: Run fsdocs
36-
run: FSharp.Formatting\src\FSharp.Formatting.CommandTool\bin\Release\netcoreapp3.1\fsdocs.exe build --sourcefolder fsharp
36+
run: FSharp.Formatting\src\FSharp.Formatting.CommandTool\bin\Release\netcoreapp3.1\fsdocs.exe build --sourcefolder fsharp --parameters fsdocs-navbar-position fixed-left
3737
- name: Deploy
3838
uses: peaceiris/actions-gh-pages@v3
3939
with:

‎.gitignore

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,8 @@ _public
55
.vscode
66
.paket
77
fsharp/
8-
FSharp.Formatting/
8+
FSharp.Formatting/
9+
.fsdocs/
10+
FSharp.Core/obj/
11+
tmp/
12+

‎FSharp.Core/FSharp.Core.fsproj

+7-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
<PackageTags>F#;async;fsharp;streaming</PackageTags>
1313
<IncludeSymbols>true</IncludeSymbols>
1414
<RepositoryUrl>https://github.com/dotnet/fsharp/</RepositoryUrl>
15+
<FsDocsLogoLink>https://fsharp.org</FsDocsLogoLink>
1516
<RepositoryType>git</RepositoryType>
1617
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1718
<OutputType>Library</OutputType>
@@ -22,11 +23,16 @@
2223
<DisableImplicitFSharpCoreReference>true</DisableImplicitFSharpCoreReference>
2324
<!-- <TargetPath>$(MSBuildThisFileDirectory)..\packages\FSharp.Core\lib\netstandard2.0\FSharp.Core.dll</TargetPath> -->
2425

26+
<FsDocsRootUrl>/</FsDocsRootUrl>
27+
<FsDocsLogoLink>https://fsharp.org</FsDocsLogoLink>
28+
<FsDocsLogoLink>https://fsharp.org</FsDocsLogoLink>
29+
2530
<!-- for a parallel checkout and build of fsharp -->
2631
<TargetPath Condition="Exists('..\..\fsharp\build.cmd')">$(MSBuildThisFileDirectory)..\..\fsharp\artifacts\bin\FSharp.Core\Debug\netstandard2.0\FSharp.Core.dll</TargetPath>
2732

2833
<!-- for a local checkout and build of fsharp in CI -->
2934
<TargetPath Condition="Exists('..\fsharp\build.cmd')">$(MSBuildThisFileDirectory)..\fsharp\artifacts\bin\FSharp.Core\Debug\netstandard2.0\FSharp.Core.dll</TargetPath>
30-
</PropertyGroup>
35+
36+
</PropertyGroup>
3137
</Project>
3238

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ For now, we want to pick up the latest copies of FSharp.Formatting and FSharp.Co
6363

6464
Then do iterative development using:
6565

66-
FSharp.Formatting\src\FSharp.Formatting.CommandTool\bin\Release\netcoreapp3.1\fsdocs.exe watch --sourcefolder fsharp
66+
FSharp.Formatting\src\FSharp.Formatting.CommandTool\bin\Release\netcoreapp3.1\fsdocs.exe watch --sourcefolder fsharp --parameters fsdocs-navbar-position fixed-left
6767

6868
## CI Pipeline
6969

‎docs/_template.html

+33-27
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,21 @@
33

44
<head>
55
<meta charset="utf-8">
6-
<title>{{page-title}}</title>
6+
<title>{{fsdocs-page-title}}</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
8-
<meta name="author" content="{{authors}}">
8+
<meta name="author" content="{{fsdocs-authors}}">
99

1010
<link rel="stylesheet" id="theme_link" href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/4.3.1/materia/bootstrap.min.css">
11-
<script src="https://code.jquery.com/jquery-3.4.1.min.js" ></script>
11+
<script src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
1212
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
1313

1414
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
1515
<!-- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script> -->
1616

17-
<link type="text/css" rel="stylesheet" href="{{root}}/content/navbar-fixed-left.css" />
18-
<link type="text/css" rel="stylesheet" href="{{root}}/content/fsdocs-style.css" />
19-
<script type="text/javascript" src="{{root}}/content/fsdocs-tips.js"></script>
17+
<link type="text/css" rel="stylesheet" href="{{root}}content/navbar-{{fsdocs-navbar-position}}.css" />
18+
<link type="text/css" rel="stylesheet" href="{{root}}content/fsdocs-style.css" />
19+
<link type="text/css" rel="stylesheet" href="{{root}}content/fsdocs-custom.css" />
20+
<script type="text/javascript" src="{{root}}content/fsdocs-tips.js"></script>
2021
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
2122
<!--[if lt IE 9]>
2223
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
@@ -28,16 +29,15 @@
2829
</head>
2930

3031
<body>
31-
<nav class="navbar navbar-expand-md navbar-light bg-secondary fixed-left">
32+
<nav class="navbar navbar-expand-md navbar-light bg-secondary {{fsdocs-navbar-position}}" id="fsdocs-menu">
3233
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
3334
<span class="navbar-toggler-icon"></span>
3435
</button>
3536
<div class="collapse navbar-collapse" id="navbarsExampleDefault">
36-
<a class="navbar-brand" href="{{root}}">{{project-name}}</a>
37-
<a href="{{root}}"><img src="{{root}}/img/logo.png" style="width:140px;height:140px;margin:10px 0px 0px 35px;border-style:none;" /></a>
37+
<a href="{{fsdocs-logo-link}}"><img id="fsdocs-logo" src="{{fsdocs-logo-src}}" /></a>
3838
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
3939
<div id="header">
40-
<div class="searchbox">
40+
<div class="searchbox" id="fsdocs-searchbox">
4141
<label for="search-by">
4242
<i class="fas fa-search"></i>
4343
</label>
@@ -50,27 +50,33 @@
5050

5151
<!-- END SEARCH BOX: this adds support for the search box -->
5252
<ul class="navbar-nav">
53-
<li class="nav-item"><a class="nav-link" href="{{repository-url}}">Source on GitHub</a></li>
54-
{{list-of-namespaces}}
53+
<li class="nav-header">Links</li>
54+
<li class="nav-item" id="fsdocs-license-link"><a class="nav-link" href="{{fsdocs-license-link}}">License (Apache 2.0)</a></li>
55+
<li class="nav-item" id="fsdocs-release-notes-link"><a class="nav-link" href="{{fsdocs-release-notes-link}}">Release Notes</a></li>
56+
<li class="nav-item" id="fsdocs-repository-link"><a class="nav-link" href="{{fsdocs-repository-link}}">Source Repository</a></li>
57+
{{fsdocs-list-of-documents}}
58+
{{fsdocs-list-of-namespaces}}
5559
</ul>
5660
</div>
5761
</nav>
58-
<div class="container" id="main">
59-
{{document}}
60-
{{tooltips}}
61-
</div>
62-
<a href="{{repository-url}}">
63-
<img style="position: absolute; top: 0; right: 0; border: 0;"
64-
src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub">
65-
</a>
62+
<div class="container">
63+
<div class="masthead">
64+
<h3 class="muted" href="{{fsdocs-collection-name-link}}">{{fsdocs-collection-name}}</h3>
65+
</div>
66+
<hr />
67+
<div class="container" id="fsdocs-main">
68+
{{fsdocs-content}}
69+
{{fsdocs-tooltips}}
70+
</div>
6671

67-
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
68-
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />
69-
<script type="text/javascript">var fsdocs_search_baseurl = '{{root}}'</script>
70-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.8/lunr.min.js"></script>
71-
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.min.js"></script>
72-
<script type="text/javascript" src="{{root}}/content/fsdocs-search.js"></script>
73-
<!-- END SEARCH BOX: this adds support for the search box -->
72+
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
73+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />
74+
<script type="text/javascript">var fsdocs_search_baseurl = '{{root}}'</script>
75+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.8/lunr.min.js"></script>
76+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.min.js"></script>
77+
<script type="text/javascript" src="{{root}}content/fsdocs-search.js"></script>
78+
<!-- END SEARCH BOX: this adds support for the search box -->
79+
</div>
7480
</body>
7581

7682
</html>

‎docs/content/fsdocs-custom.css

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
/*--------------------------------------------------------------------------
3+
Customize your CSS here
4+
/*--------------------------------------------------------------------------*/
5+

0 commit comments

Comments
 (0)