End-User Documentation New Structure (WIP) (#2336)

* End-User Documentation New Structure (WIP) to customize template * Format style.fsx * Change docs name section from Documentation to End-user documentation * End-User Documentation New Structure (WIP) to customize template * Format style.fsx * - Reverted img folder to images - Add new FAQ section - Changed contributors list - Cleanup template unused statements - Change section name from Documentation to End-user documentation * - Revert img folder to images - Add new FAQ section - Change contributors list - Cleanup template unused statements - Change section name from Documentation to End-user documentation - Delete styleguide to build a new one - Getting Started section divided in multiple pages - Remove fantomas-fmt from recommended - Remove default stylings * mend * - Add fsharp_max_if_then_short_width to the docs - Create new benchmarks page - Add basic styling for main theme (WIP) * - Stop compiling globalConfig - Tweak fsdocs-custom.sass to add common selector for headers * - Fix markdown section name * - Bootstrap sidebar - Temporal script to modify fs-docs default stylings - Add coloring styling for F# code - Add logo and searchbar for namespaces * Import sidebar sass file. * Add FsDocsLogoSource. * Some minor fixes. * Format style.fsx Co-authored-by: nojaf <florian.verdonck@outlook.com>
fsprojects · Jul 15, 2022 · 87cd212 · 87cd212
1 parent 56a47b0
commit 87cd212
Show file tree

Hide file tree

Showing 28 changed files with 10,125 additions and 56 deletions.
diff --git a/.gitignore b/.gitignore
@@ -188,5 +188,9 @@ src/Fantomas.FCS/generated/
 # FsDocs
 docs/homepage.css
 docs/homepage.css.map
+docs/content/fsdocs-custom.css
+docs/content/navbar.css
+docs/content/sidebar.css
+docs/global-config.css
 output/
-**/.fsdocs/cache
+**/.fsdocs/cache
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -27,6 +27,7 @@ Some common use cases include:
     <PropertyGroup>
         <FsDocsLicenseLink>https://github.com/fsprojects/fantomas/blob/master/LICENSE.md</FsDocsLicenseLink>
         <FsDocsReleaseNotesLink>https://github.com/fsprojects/fantomas/blob/master/CHANGELOG.md</FsDocsReleaseNotesLink>
+        <FsDocsLogoSource>images/logo-fantomas-color.svg</FsDocsLogoSource>
         <RepositoryUrl>https://github.com/fsprojects/fantomas</RepositoryUrl>
     </PropertyGroup>
 

diff --git a/docs/.style/fsdocs-custom.sass b/docs/.style/fsdocs-custom.sass
@@ -0,0 +1,106 @@
+@import "./global-config.sass"
+@import "./fsdocs-default.css"
+
+main
+  display: flex
+
+#fsdocs-nav
+  #fsdocs-logo
+    width: 90%
+    margin-top: 40px
+    border-style: none
+
+  input
+    margin-right: 20px
+    margin-top: 20px
+    margin-bottom: 20px
+    width: 93%
+    -webkit-border-radius: 0
+    border-radius: 0
+
+  font-size: 0.95rem
+
+  .nav-header
+    padding-left: 0
+    color: $black
+    text-transform: none
+    font-size: 16px
+    margin-top: 9px
+    font-weight: bold
+
+  a
+    padding-left: 0
+    color: $gray
+
+blockquote 
+    margin: 0 1em 0 0.25em
+    margin-top: 0px
+    margin-right: 1em
+    margin-bottom: 0px
+    margin-left: 0.25em
+    padding: 0 .75em 0 1em
+    border-left: 1px solid $gray
+    border-right: 0px solid $gray
+
+
+#fsdocs-content
+
+    h1, h2, h3, h4, h5, h6 
+      a
+        color: $black
+        text-decoration: none
+        text-decoration-style: none
+
+      &:hover, &:focus
+        color: $black
+        text-decoration: none
+        text-decoration-style: none
+
+    h1
+        margin: 30px 0px 15px 0px
+        font-size: 2rem
+        letter-spacing: 1.78px
+        line-height: 2.5rem
+        font-weight: 400
+    h2
+        font-size: 1.6rem
+        margin: 20px 0px 10px 0px
+        font-weight: 400
+    h3
+        font-size: 1.2rem
+        margin: 15px 0px 10px 0px
+        font-weight: 400
+    hr
+        margin: 0px 0px 20px 0px
+    li
+        font-size: 1.0rem
+        line-height: 1.375rem
+        letter-spacing: 0.01px
+        font-weight: 500
+        margin: 0px 0px 15px 0px
+    p
+        font-size: 1.0rem
+        line-height: 1.375rem
+        letter-spacing: 0.01px
+        font-weight: 500
+        color: $black
+    a   
+        color: $primary
+    dt
+        font-weight:normal
+
+.fsdocs-source-link
+  float: right
+  text-decoration: none
+
+  img
+    border-style: none
+    margin-left: 10px
+    width: auto
+    height: 1.4em
+
+#fsdocs-logo
+    width: 140px
+    height: 140px
+    margin: 10px 0 0 0
+  border-style: none
diff --git a/docs/.style/fsdocs-default.css b/docs/.style/fsdocs-default.css
@@ -0,0 +1,227 @@
+
+/*--------------------------------------------------------------------------
+  Formatting pre and code sections in fsdocs-content (code highlighting is
+    further below)
+/*--------------------------------------------------------------------------*/
+
+#fsdocs-content code {
+    /* font-size: 0.83rem; */
+    font: 0.85rem 'Roboto Mono', monospace;
+    background-color: #f7f7f900;
+    border: 0px;
+    padding: 0px;
+    /* word-wrap: break-word; */
+    /* white-space: pre; */
+}
+
+/* omitted */
+#fsdocs-content span.omitted {
+    background: #3c4e52;
+    border-radius: 5px;
+    color: #808080;
+    padding: 0px 0px 1px 0px;
+}
+
+#fsdocs-content pre .fssnip code {
+    font: 0.86rem 'Roboto Mono', monospace;
+}
+
+#fsdocs-content table.pre,
+#fsdocs-content pre.fssnip,
+#fsdocs-content pre {
+    line-height: 13pt;
+    border: 0px solid #d8d8d8;
+    border-top: 0px solid #e3e3e3;
+    border-collapse: separate;
+    white-space: pre;
+    font: 0.86rem 'Roboto Mono', monospace;
+    width: 100%;
+    margin: 10px 0px 20px 0px;
+    background-color: #f3f4f7;
+    padding: 10px;
+    border-radius: 5px;
+    color: #8e0e2b;
+    max-width: none;
+    box-sizing: border-box;
+}
+
+#fsdocs-content pre.fssnip code {
+    font: 0.86rem 'Roboto Mono', monospace;
+    font-weight: 600;
+}
+
+#fsdocs-content table.pre {
+    background-color: #fff7ed;
+}
+
+#fsdocs-content table.pre pre {
+    padding: 0px;
+    margin: 0px;
+    border-radius: 0px;
+    width: 100%;
+    background-color: #fff7ed;
+    color: #837b79;
+}
+
+#fsdocs-content table.pre td {
+    padding: 0px;
+    white-space: normal;
+    margin: 0px;
+    width: 100%;
+}
+
+#fsdocs-content table.pre td.lines {
+    width: 30px;
+}
+
+
+#fsdocs-content pre {
+    word-wrap: inherit;
+}
+
+.fsdocs-example-header {
+    font-size: 1.0rem;
+    line-height: 1.375rem;
+    letter-spacing: 0.01px;
+    font-weight: 700;
+    color: #262626;
+}
+
+/*--------------------------------------------------------------------------
+  Formatting for F# code snippets
+/*--------------------------------------------------------------------------*/
+
+.fsdocs-param-name,
+.fsdocs-return-name,
+.fsdocs-param {
+    font-weight: 900;
+    font-size: 0.85rem;
+    font-family: 'Roboto Mono', monospace;
+}
+/* strings --- and stlyes for other string related formats */
+#fsdocs-content span.s {
+    color: #dd1144;
+}
+/* printf formatters */
+#fsdocs-content span.pf {
+    color: #E0C57F;
+}
+/* escaped chars */
+#fsdocs-content span.e {
+    color: #EA8675;
+}
+
+/* identifiers --- and styles for more specific identifier types */
+#fsdocs-content span.id {
+    color: #262626;
+}
+/* module */
+#fsdocs-content span.m {
+    color: #009999;
+}
+/* reference type */
+#fsdocs-content span.rt {
+    color: #4974D1;
+}
+/* value type */
+#fsdocs-content span.vt {
+    color: #43AEC6;
+}
+/* interface */
+#fsdocs-content span.if {
+    color: #43AEC6;
+}
+/* type argument */
+#fsdocs-content span.ta {
+    color: #43AEC6;
+}
+/* disposable */
+#fsdocs-content span.d {
+    color: #43AEC6;
+}
+/* property */
+#fsdocs-content span.prop {
+    color: #43AEC6;
+}
+/* punctuation */
+#fsdocs-content span.p {
+    color: #43AEC6;
+}
+#fsdocs-content span.pn {
+    color: #262626;
+}
+/* function */
+#fsdocs-content span.f {
+    color: #e1e1e1;
+}
+#fsdocs-content span.fn {
+    color: #990000;
+}
+/* active pattern */
+#fsdocs-content span.pat {
+    color: #4ec9b0;
+}
+/* union case */
+#fsdocs-content span.u {
+    color: #4ec9b0;
+}
+/* enumeration */
+#fsdocs-content span.e {
+    color: #4ec9b0;
+}
+/* keywords */
+#fsdocs-content span.k {
+    color: #b68015;
+    /* font-weight: bold; */
+}
+/* comment */
+#fsdocs-content span.c {
+    color: #808080;
+    font-weight: 400;
+    font-style: italic;
+}
+/* operators */
+#fsdocs-content span.o {
+    color: #af75c1;
+}
+/* numbers */
+#fsdocs-content span.n {
+    color: #009999;
+}
+/* line number */
+#fsdocs-content span.l {
+    color: #80b0b0;
+}
+/* mutable var or ref cell */
+#fsdocs-content span.v {
+    color: #d1d1d1;
+    font-weight: bold;
+}
+/* inactive code */
+#fsdocs-content span.inactive {
+    color: #808080;
+}
+/* preprocessor */
+#fsdocs-content span.prep {
+    color: #af75c1;
+}
+/* fsi output */
+#fsdocs-content span.fsi {
+    color: #808080;
+}
+
+/* tool tip */
+div.fsdocs-tip {
+    background: #475b5f;
+    border-radius: 4px;
+    font: 0.85rem 'Roboto Mono', monospace;
+    padding: 6px 8px 6px 8px;
+    display: none;
+    color: #d1d1d1;
+    pointer-events: none;
+}
+
+div.fsdocs-tip code {
+    color: #d1d1d1;
+    font: 0.85rem 'Roboto Mono', monospace;
+}