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

Promote zero-to-hero to the first documentation page. #911

Merged
merged 2 commits into from
Mar 19, 2024
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
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
11 changes: 4 additions & 7 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 @@ -28,7 +28,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 1,
"id": "fdf16de9",
"metadata": {
"dotnet_interactive": {
Expand All @@ -40,17 +40,14 @@
"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",
"<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>Alf</pre></div></td></tr><tr><td>Phone</td><td><div class=\"dni-plaintext\"><pre>(555) 555-5555</pre></div></td></tr><tr><td>ZipCode</td><td><div class=\"dni-plaintext\"><pre>90210</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",
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