Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

F#5 for Docs -- One Approach #102

Merged
merged 11 commits into from
Apr 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .config/dotnet-tools.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"version": 1,
"isRoot": true,
"tools": {
"FSharp.Formatting.CommandTool":{
"version": "4.0.0-rc2",
"FSharp.Formatting.CommandTool": {
"version": "9.0.1",
"commands": [
"fsformatting"
"fsdocs"
]
}
}
}
}
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ packages/*
docsrc/content/license.md
docsrc/content/release-notes.md
*.user

# FSFormatting
.fsdocs/
tmp/watch
1 change: 1 addition & 0 deletions Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<Version Condition=" '$(VersionSuffix)' == '' ">$(VersionPrefix)</Version>
<AssemblyVersion>$(VersionPrefix).0</AssemblyVersion>
<FileVersion>$(VersionPrefix).0</FileVersion>

</PropertyGroup>

<ItemGroup>
Expand Down
5 changes: 2 additions & 3 deletions docsrc/content/codec.fsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
(*** hide ***)
// This block of code is omitted in the generated HTML documentation. Use
// it to define helpers that you do not want to show in the documentation.
#r @"../../src/Fleece.SystemJson/bin/Release/netstandard2.1/System.Json.dll"
#r "nuget: FSharpPlus"
#r "nuget: System.Json"
#r @"../../src/Fleece.SystemJson/bin/Release/netstandard2.1/Fleece.SystemJson.dll"
#r @"../../src/Fleece.SystemJson/bin/Release/netstandard2.1/FSharpPlus.dll"

open System.Json
open Fleece.SystemJson
open Fleece.SystemJson.Operators

Expand Down
6 changes: 2 additions & 4 deletions docsrc/content/combinators.fsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
(*** hide ***)
// This block of code is omitted in the generated HTML documentation. Use
// it to define helpers that you do not want to show in the documentation.
#r @"../../src/Fleece.SystemJson/bin/Release/netstandard2.1/System.Json.dll"
#r "nuget: FSharpPlus"
#r "nuget: System.Json"
#r @"../../src/Fleece.SystemJson/bin/Release/netstandard2.1/Fleece.SystemJson.dll"
#r @"../../src/Fleece.SystemJson/bin/Release/netstandard2.1/FSharpPlus.dll"

open System.Json
open Fleece.SystemJson
open Fleece.SystemJson.Operators

(**
## Combinators
Expand Down
6 changes: 3 additions & 3 deletions docsrc/content/comparison-with-json-net.fsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
(*** hide ***)
// This block of code is omitted in the generated HTML documentation. Use
// it to define helpers that you do not want to show in the documentation.
#r @"../../src/Fleece.NewtonsoftJson/bin/Release/netstandard2.1/Newtonsoft.Json.dll"
#r @"nuget: Newtonsoft.Json"
#r "nuget: FSharpPlus, 1.1.7"
#r @"../../src/Fleece.SystemJson/bin/Release/netstandard2.1/Fleece.SystemJson.dll"
#r @"../../src/Fleece.NewtonsoftJson/bin/Release/netstandard2.1/Fleece.NewtonsoftJson.dll"
#r @"../../src/Fleece.NewtonsoftJson/bin/Release/netstandard2.1/FSharpPlus.dll"

open System
open Newtonsoft.Json
open FSharpPlus
open FSharpPlus.Builders
open Fleece.Newtonsoft
open Fleece.Newtonsoft.Operators

Expand Down
Binary file added docsrc/content/content/favicon.ico
Binary file not shown.
35 changes: 35 additions & 0 deletions docsrc/content/content/img/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
243 changes: 243 additions & 0 deletions docsrc/content/content/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@
@import url(https://fonts.googleapis.com/css?family=Droid+Sans|Droid+Sans+Mono|Open+Sans:400,600,700);

/*--------------------------------------------------------------------------
Formatting for F# code snippets
/*--------------------------------------------------------------------------*/

/* strings --- and stlyes for other string related formats */
span.s { color:#E0E268; }
/* printf formatters */
span.pf { color:#E0C57F; }
/* escaped chars */
span.e { color:#EA8675; }

/* identifiers --- and styles for more specific identifier types */
span.id { color:#d1d1d1; }
/* module */
span.m { color:#43AEC6; }
/* reference type */
span.rt { color:#43AEC6; }
/* value type */
span.vt { color:#43AEC6; }
/* interface */
span.if{ color:#43AEC6; }
/* type argument */
span.ta { color:#43AEC6; }
/* disposable */
span.d { color:#43AEC6; }
/* property */
span.prop { color:#43AEC6; }
/* punctuation */
span.p { color:#43AEC6; }
/* function */
span.f { color:#e1e1e1; }
/* active pattern */
span.pat { color:#4ec9b0; }
/* union case */
span.u { color:#4ec9b0; }
/* enumeration */
span.e { color:#4ec9b0; }
/* keywords */
span.k { color:#FAB11D; }
/* comment */
span.c { color:#808080; }
/* operators */
span.o { color:#af75c1; }
/* numbers */
span.n { color:#96C71D; }
/* line number */
span.l { color:#80b0b0; }
/* mutable var or ref cell */
span.v { color:#d1d1d1; font-weight: bold; }
/* inactive code */
span.inactive { color:#808080; }
/* preprocessor */
span.prep { color:#af75c1; }
/* fsi output */
span.fsi { color:#808080; }

/* omitted */
span.omitted {
background:#3c4e52;
border-radius:5px;
color:#808080;
padding:0px 0px 1px 0px;
}
/* tool tip */
div.tip {
background:#475b5f;
border-radius:4px;
font:11pt 'Droid Sans', arial, sans-serif;
padding:6px 8px 6px 8px;
display:none;
color:#d1d1d1;
pointer-events:none;
}
table.pre pre {
padding:0px;
margin:0px;
border:none;
}
table.pre, pre.fssnip, pre {
line-height:13pt;
border:1px solid #d8d8d8;
border-collapse:separate;
white-space:pre;
font: 9pt 'Droid Sans Mono',consolas,monospace;
width:90%;
margin:10px 20px 20px 20px;
background-color:#212d30;
padding:10px;
border-radius:5px;
color:#d1d1d1;
max-width: none;
}
pre.fssnip code {
font: 9pt 'Droid Sans Mono',consolas,monospace;
}
table.pre pre {
padding:0px;
margin:0px;
border-radius:0px;
width: 100%;
}
table.pre td {
padding:0px;
white-space:normal;
margin:0px;
}
table.pre td.lines {
width:30px;
}

/*--------------------------------------------------------------------------
Formatting for page & standard document content
/*--------------------------------------------------------------------------*/

body {
font-family: 'Open Sans', serif;
padding-top: 0px;
padding-bottom: 40px;
}

pre {
word-wrap: inherit;
}

/* Format the heading - nicer spacing etc. */
.masthead {
overflow: hidden;
}
.masthead .muted a {
text-decoration:none;
color:#999999;
}
.masthead ul, .masthead li {
margin-bottom:0px;
}
.masthead .nav li {
margin-top: 15px;
font-size:110%;
}
.masthead h3 {
margin-bottom:5px;
font-size:170%;
}
hr {
margin:0px 0px 20px 0px;
}

/* Make table headings and td.title bold */
td.title, thead {
font-weight:bold;
}

/* Format the right-side menu */
#menu {
margin-top:50px;
font-size:11pt;
padding-left:20px;
}

#menu .nav-header {
font-size:12pt;
color:#606060;
margin-top:20px;
}

#menu li {
line-height:25px;
}

/* Change font sizes for headings etc. */
#main h1 { font-size: 26pt; margin:10px 0px 15px 0px; font-weight:400; }
#main h2 { font-size: 20pt; margin:20px 0px 0px 0px; font-weight:400; }
#main h3 { font-size: 14pt; margin:15px 0px 0px 0px; font-weight:600; }
#main p { font-size: 11pt; margin:5px 0px 15px 0px; }
#main ul { font-size: 11pt; margin-top:10px; }
#main li { font-size: 11pt; margin: 5px 0px 5px 0px; }
#main strong { font-weight:700; }

/*--------------------------------------------------------------------------
Formatting for API reference
/*--------------------------------------------------------------------------*/

.type-list .type-name, .module-list .module-name {
width:25%;
font-weight:bold;
}
.member-list .member-name {
width:35%;
}
#main .xmldoc h2 {
font-size:14pt;
margin:10px 0px 0px 0px;
}
#main .xmldoc h3 {
font-size:12pt;
margin:10px 0px 0px 0px;
}
.github-link {
float:right;
text-decoration:none;
}
.github-link img {
border-style:none;
margin-left:10px;
}
.github-link .hover { display:none; }
.github-link:hover .hover { display:block; }
.github-link .normal { display: block; }
.github-link:hover .normal { display: none; }

/*--------------------------------------------------------------------------
Links
/*--------------------------------------------------------------------------*/

h1 a, h1 a:hover, h1 a:focus,
h2 a, h2 a:hover, h2 a:focus,
h3 a, h3 a:hover, h3 a:focus,
h4 a, h4 a:hover, h4 a:focus,
h5 a, h5 a:hover, h5 a:focus,
h6 a, h6 a:hover, h6 a:focus { color : inherit; text-decoration : inherit; outline:none }

/*--------------------------------------------------------------------------
Additional formatting for the homepage
/*--------------------------------------------------------------------------*/

#nuget {
margin-top:20px;
font-size: 11pt;
padding:20px;
}

#nuget pre {
font-size:11pt;
-moz-border-radius: 0px;
-webkit-border-radius: 0px;
border-radius: 0px;
background: #404040;
border-style:none;
color: #e0e0e0;
margin-top:15px;
}
Loading