Skip to content

Commit

Permalink
Promote zero-to-hero to the first documentation page.
Browse files Browse the repository at this point in the history
  • Loading branch information
nhirschey committed Mar 19, 2024
1 parent adef74c commit ac9376a
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 56 deletions.
2 changes: 1 addition & 1 deletion docs/apidocs.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
title: Generating API Docs
category: Documentation
categoryindex: 1
index: 6
index: 7
---
*)
(*** condition: prepare ***)
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
category: Documentation
categoryindex: 1
index: 1
index: 2
---
# Command line

Expand Down
2 changes: 1 addition & 1 deletion docs/content.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
---
category: Documentation
categoryindex: 1
index: 5
index: 6
---
*)
(*** condition: prepare ***)
Expand Down
2 changes: 1 addition & 1 deletion docs/evaluation.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
---
category: Documentation
categoryindex: 1
index: 7
index: 8
---
*)
(*** condition: prepare ***)
Expand Down
50 changes: 3 additions & 47 deletions docs/literate-notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"\n",
"categoryindex: 1\n",
"\n",
"index: 4\n",
"index: 5\n",
"\n",
"---\n",
"\n",
Expand All @@ -40,54 +40,10 @@
"kernelName": "fsharp"
},
"vscode": {
"languageId": "fsharp"
"languageId": "polyglot-notebook"
}
},
"outputs": [
{
"data": {
"text/html": [
"<details open=\"open\" class=\"dni-treeview\"><summary><span class=\"dni-code-hint\"><code>{ Name = &quot;Alf&quot;\\n Phone = &quot;(555) 555-5555&quot;\\n ZipCode = &quot;90210&quot; }</code></span></summary><div><table><thead><tr></tr></thead><tbody><tr><td>Name</td><td><div class=\"dni-plaintext\"><pre>&quot;Alf&quot;\r\n",
"</pre></div></td></tr><tr><td>Phone</td><td><div class=\"dni-plaintext\"><pre>&quot;(555) 555-5555&quot;\r\n",
"</pre></div></td></tr><tr><td>ZipCode</td><td><div class=\"dni-plaintext\"><pre>&quot;90210&quot;\r\n",
"</pre></div></td></tr></tbody></table></div></details><style>\r\n",
".dni-code-hint {\r\n",
" font-style: italic;\r\n",
" overflow: hidden;\r\n",
" white-space: nowrap;\r\n",
"}\r\n",
".dni-treeview {\r\n",
" white-space: nowrap;\r\n",
"}\r\n",
".dni-treeview td {\r\n",
" vertical-align: top;\r\n",
" text-align: start;\r\n",
"}\r\n",
"details.dni-treeview {\r\n",
" padding-left: 1em;\r\n",
"}\r\n",
"table td {\r\n",
" text-align: start;\r\n",
"}\r\n",
"table tr { \r\n",
" vertical-align: top; \r\n",
" margin: 0em 0px;\r\n",
"}\r\n",
"table tr td pre \r\n",
"{ \r\n",
" vertical-align: top !important; \r\n",
" margin: 0em 0px !important;\r\n",
"} \r\n",
"table th {\r\n",
" text-align: start;\r\n",
"}\r\n",
"</style>"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"outputs": [],
"source": [
"type ContactCard =\n",
" { Name: string\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/literate.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
---
category: Documentation
categoryindex: 1
index: 3
index: 4
---
*)
(*** condition: prepare ***)
Expand Down
2 changes: 1 addition & 1 deletion docs/styling.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
category: Documentation
categoryindex: 1
index: 8
index: 9
---

# Customization and Styling
Expand Down
2 changes: 1 addition & 1 deletion docs/users.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
category: Documentation
categoryindex: 1
index: 9
index: 10
---
# Users of FSharp.Formatting

Expand Down
6 changes: 4 additions & 2 deletions docs/zero-to-hero.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Getting Started
category: Documentation
categoryindex: 1
index: 10
index: 1
---
# From zero to hero: deploying to GitHub Pages
# Getting Started
## From zero to hero: deploying to GitHub Pages

This guide is meant for a typical setup of open-source projects on GitHub.
We start from a repository without any documentation and aim to end up with a published website on [GitHub Pages](https://pages.github.com/).
Expand Down

0 comments on commit ac9376a

Please sign in to comment.