Use fsdocs-previous-page-link and fsdocs-next-page-link (#2957)

* Use fsdocs-previous-page-link and fsdocs-next-page-link * Update docs/docs/end-users/GettingStarted.fsx Co-authored-by: dawe <[email protected]> --------- Co-authored-by: dawe <[email protected]>
fsprojects · Sep 15, 2023 · c3b899d · c3b899d
1 parent 74b1812
commit c3b899d
Show file tree

Hide file tree

Showing 30 changed files with 38 additions and 36 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -15,7 +15,7 @@
       ]
     },
     "fsdocs-tool": {
-      "version": "19.0.0",
+      "version": "19.1.0",
       "commands": [
         "fsdocs"
       ]

diff --git a/build.fsx b/build.fsx
@@ -1,6 +1,6 @@
-#r "nuget: Fun.Build, 0.3.8"
-#r "nuget: CliWrap, 3.5.0"
-#r "nuget: FSharp.Data, 5.0.2"
+#r "nuget: Fun.Build, 0.5.3"
+#r "nuget: CliWrap, 3.6.4"
+#r "nuget: FSharp.Data, 6.3.0"
 #r "nuget: Ionide.KeepAChangelog, 0.1.8"
 #r "nuget: Humanizer.Core, 2.14.1"
 
@@ -477,3 +477,5 @@ pipeline "Release" {
     }
     runIfOnlySpecified true
 }
+
+tryPrintPipelineCommandHelp ()
diff --git a/docs/docs/contributors/Conditional Compilation Directives.md b/docs/docs/contributors/Conditional Compilation Directives.md
@@ -151,4 +151,4 @@ After merging:
 [ "let a ="; "#if DEBUG"; "0"; "#else"; "1"; "#endif" ]
 ```
 
-<fantomas-nav previous="./Formatted%20Code.html" next="./How%20Can%20I%20Contribute.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/FSharp.md b/docs/docs/contributors/FSharp.md
@@ -108,4 +108,4 @@ Although, it really is an implementation detail in `Context.fs`, think of it as
 We first rehearse what we want to say, then we write the letter. Not write evey word as we are making up the letter, but write the letter as a whole once we know the content.  
 These events are used to achieve this.
 
-<fantomas-nav previous="./index.html" next="./Getting%20Started.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Formatted Code.md b/docs/docs/contributors/Formatted Code.md
@@ -23,4 +23,4 @@ When there are any warnings or errors, we will throw an exception.
 Some warnings are are allowed as they indicate problems that were most likely already present in the input code.
 See `Validation.fs` for more details.
 
-<fantomas-nav previous="./Print%20AST%20with%20Context.html" next="./Conditional%20Compilation%20Directives.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Getting Started.md b/docs/docs/contributors/Getting Started.md
@@ -75,4 +75,4 @@ Examples:
 -  `dotnet fsi build.fsx -p EnsureRepoConfig` sets up some git repo-level configuration to ensure
 that formatting of new code is consistent before it is pushed up to a remote repository.
 
-<fantomas-nav previous="./FSharp.html" next="./Solution%20Structure.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Glossary.md b/docs/docs/contributors/Glossary.md
@@ -59,4 +59,4 @@ The AST from the FCS used by Fantomas.
 It represents the source code as it was processed by the F# compiler. The _Untyped Syntax Tree_ doesn't carry any information regarding the validity of the source code or semantics.
 In a later compilation stage, the _Untyped Syntax Tree_ is transformed into the _Typed Syntax Tree_.
 
-<fantomas-nav previous="./Pull%20request%20ground%20rules.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/How Can I Contribute.md b/docs/docs/contributors/How Can I Contribute.md
@@ -192,4 +192,4 @@ This update to the tree made it very straightforward to fix the original bug in
 
 Another example of code that could benefit from a better representation is [extern](https://github.com/fsprojects/fantomas/issues?q=is%3Aissue+is%3Aopen+extern).
 
-<fantomas-nav previous="./Conditional%20Compilation%20Directives.html" next="./The%20Missing%20Comment.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Index.md b/docs/docs/contributors/Index.md
@@ -27,4 +27,4 @@ There is currently [a known issue](https://github.com/fsprojects/fantomas/issues
 
 To workaround this in the meantime, you'll need to comment out the references to `Ionide.KeepAChangelog.Tasks` in `Directory.Build.props` and all of the `packages.lock.json` files, and then run `dotnet restore`. **Please be careful not to include these changes when submitting a PR!**
 
-<fantomas-nav next="./FSharp.html"></fantomas-nav>
+<fantomas-nav next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Multiple Times.md b/docs/docs/contributors/Multiple Times.md
@@ -143,4 +143,4 @@ Use the following naming convention suffix:
 - `, defineA defineB` for the `[ "defineA"; "defineB" ]` case
 - `, issue-number` for the full test.
 
-<fantomas-nav previous="./The%20Missing%20Comment.html" next="./Pull%20request%20ground%20rules.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Pull request ground rules.md b/docs/docs/contributors/Pull request ground rules.md
@@ -195,4 +195,4 @@ A user should only need to deal with style changes when they have explicitly [ch
 In case no major or minor branch was created yet, please reach out to the maintainers.
 The maintainers will frequently rebase this branch on top of the main branch and release alpha/beta packages accordingly.
 
-<fantomas-nav previous="Multiple%20Times.html" next="./Updating%20the%20compiler.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Releases.md b/docs/docs/contributors/Releases.md
@@ -77,4 +77,4 @@ Upload the `*.nupkg` files to the release artifacts.
 Share the newly created release on our Discord server in the `#announcements` channel.  
 Optionally share (minor or major) releases on other social media. 
 
-<fantomas-nav previous="./Updating%20the%20compiler.html" next="./Glossary.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Solution Structure.md b/docs/docs/contributors/Solution Structure.md
@@ -61,4 +61,4 @@ A suite of end-to-end tests that run the actual `fantomas` command line applicat
 
 A suite of end-to-end tests that will verify the `Fantomas.Client` code against released versions of `fantomas`.
 
-<fantomas-nav previous="./Getting%20Started.html" next="./Transforming.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/The Missing Comment.md b/docs/docs/contributors/The Missing Comment.md
@@ -102,4 +102,4 @@ let genSingleTextNode (node: SingleTextNode) = !-node.Text |> genNode node
 
 `enterNode` and `leaveNode` will print the `TriviaNodes` using `genTrivia`. 
 
-<fantomas-nav previous="./How%20Can%20I%20Contribute.html" next="./Multiple%20Times.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Transforming.md b/docs/docs/contributors/Transforming.md
@@ -161,4 +161,4 @@ graph TD
     B[Insert trivia into nodes]
  </div>
 
-<fantomas-nav previous="./Solution%20Structure.html" next="./Traverse.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Traverse.md b/docs/docs/contributors/Traverse.md
@@ -87,4 +87,4 @@ The `dumpAndContinue` helper function can be used to inspect the `Context`.
 Please remove all usages when submitting a PR 😸.
 
 
-<fantomas-nav previous="./Transforming.html" next="./Formatted%20Code.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/contributors/Updating the compiler.md b/docs/docs/contributors/Updating the compiler.md
@@ -37,4 +37,4 @@ Even if the tests are all green you should take a look at all the changes made t
 
 Think about tests to catch any regressions caused by the update and it's effects on Fantomas.
 
-<fantomas-nav previous="./Pull%20request%20ground%20rules.html" next="./Releases.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/Configuration.fsx b/docs/docs/end-users/Configuration.fsx
@@ -983,6 +983,6 @@ let singleList =
 (*** include-output ***)
 
 (**
-<fantomas-nav previous="./StyleGuide.html" next="./IgnoreFiles.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
 
 *)
diff --git a/docs/docs/end-users/FAQ.md b/docs/docs/end-users/FAQ.md
@@ -44,4 +44,4 @@ without the compiler nagging you about the missing space between the callee (`Pr
 Since F# 6.0, Fantomas interprets the list as an index expression and formats it accordingly.  
 In such a case, just add a space between the callee and the list and you should be good to go.
 
-<fantomas-nav previous="./UpgradeGuide.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/FormattingCheck.md b/docs/docs/end-users/FormattingCheck.md
@@ -116,4 +116,4 @@ Or, more likely, you have something slightly different in your code base that is
 No matter the case, when you have a `--check` command somewhere in your continuous integration environment, please consider running a build with the latest compatible version from time to time.  
 It really helps us spotting problems early on and we can more easily pinpoint the problem due to lesser recent changes.
 
-<fantomas-nav previous="./IgnoreFiles.html" next="./GitHooks.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/GeneratingCode.fsx b/docs/docs/end-users/GeneratingCode.fsx
@@ -2,7 +2,7 @@
 ---
 category: End-users
 categoryindex: 1
-index: 9
+index: 10
 ---
 *)
 (**
@@ -208,5 +208,5 @@ We do not apply any semantic versioning to `Fantomas.FCS` or `Fantomas.Core.Synt
 Our recommendation is that you include a set of regression tests  to meet your own expectations when upgrading.  
 As none of our versions are compatible it is advised to take a very strict dependency on `Fantomas.Core`. Using constraints like `(>= 6.0.0)` will inevitably lead to unexpected problems. 
 
-<fantomas-nav previous="./VSCode.html" next="./UpgradeGuide.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
 *)
diff --git a/docs/docs/end-users/GettingStarted.fsx b/docs/docs/end-users/GettingStarted.fsx
@@ -90,5 +90,5 @@ Or usage with `find` on Unix:
 find my-project/ -type f -name "*.fs" -not -path "*obj*" | xargs dotnet fantomas --check
 ```
 
-<fantomas-nav previous="../index.html" next="./StyleGuide.html"></fantomas-nav>
+<fantomas-nav previous="../index.html" next="{{fsdocs-next-page-link}}"></fantomas-nav>
 *)
diff --git a/docs/docs/end-users/GitHooks.md b/docs/docs/end-users/GitHooks.md
@@ -24,4 +24,4 @@ git diff --cached --name-only --diff-filter=ACM -z | xargs -0 git add
 
 **Please use with caution** as [Fantomas is not without bugs](https://github.com/fsprojects/fantomas/issues?q=is%3Aissue+is%3Aopen+label%3A%22bug+%28soundness%29%22).
 
-<fantomas-nav previous="./FormattingCheck.html" next="./Rider.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/IgnoreFiles.md b/docs/docs/end-users/IgnoreFiles.md
@@ -39,4 +39,4 @@ Fantomas is not perfect, there are open issues and depending on what shenanigans
 Before you've decided that Fantomas is not for you, you might want to use a `.fantomasignore` file to overcome that one problem.
 In the past people have been quick to judge that the tool cannot be used, however, through a different looking glass Fantomas maybe did format *99%* of your code correctly.
 
-<fantomas-nav previous="./Configuration.html" next="./FormattingCheck.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/Rider.md b/docs/docs/end-users/Rider.md
@@ -58,4 +58,4 @@ fsharp_keep_max_number_of_blank_lines=100
 fsharp_strict_mode=false
 ```
 
-<fantomas-nav previous="./GitHooks.html" next="./VisualStudio.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/StyleGuide.md b/docs/docs/end-users/StyleGuide.md
@@ -54,4 +54,4 @@ To strengthen the message of unity we advice that you do not change the default
 The **out-of-the-box experience** should be a result of what the **brightest minds of the community** came up with.
 If you are _new_ to the F# language, this is what you want.
 
-<fantomas-nav previous="./GettingStarted.html" next="./Configuration.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/UpgradeGuide.md b/docs/docs/end-users/UpgradeGuide.md
@@ -1,7 +1,7 @@
 ---
 category: End-users
 categoryindex: 1
-index: 12
+index: 11
 ---
 # Upgrade guide
 
@@ -82,4 +82,4 @@ fsharp_experimental_stroustrup_style = true
 ### Miscellaneous
 - The namespace in [Fantomas.FCS](https://www.nuget.org/packages/Fantomas.FCS) changed from `FSharp.Compiler` to `Fantomas.FCS`.
 
-<fantomas-nav previous="./VSCode.html" next="./FAQ.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/VSCode.md b/docs/docs/end-users/VSCode.md
@@ -1,7 +1,7 @@
 ---
 category: End-users
 categoryindex: 1
-index: 8
+index: 9
 ---
 # Visual Studio Code
 The recommended way to use Fantomas in Visual Studio Code is by using the [Ionide plugin](http://ionide.io/). Fantomas is integrated in [FSAutoComplete](https://github.com/fsharp/FsAutoComplete/) which is the language server used by Ionide.  
@@ -24,4 +24,4 @@ Fantomas version detection will try and find a compatible version in the followi
 2. Your global Fantomas version. If fantomas was installed with `dotnet tool install fantomas -g`. You can see your global installations with `dotnet tool list -g`.  
 3. Executable named `fantomas` found in your PATH.
 
-<fantomas-nav previous="./VisualStudio.html" next="./GeneratingCode.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/end-users/VisualStudio.md b/docs/docs/end-users/VisualStudio.md
@@ -1,7 +1,7 @@
 ---
 category: End-users
 categoryindex: 1
-index: 7
+index: 8
 ---
 # Visual Studio
 The F# Formatting extension sets up Fantomas as the default formatter for F# files, configurable from Visual Studio's options.  
@@ -19,4 +19,4 @@ Do note that the extension might not be up to date with the latest version of Fa
 
 <img src="{{root}}/images/vsmac-external-tool.png" alt="drawing" width="70%"/>
 
-<fantomas-nav previous="./Rider.html" next="./VSCode.html"></fantomas-nav>
+<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -23,4 +23,4 @@ We would like to gratefully thank the following persons for their [contributions
 The library and tool are available under Apache 2.0 license.
 For more information see the [License file](https://github.com/fsprojects/fantomas/blob/main/LICENSE.md).
 
-<fantomas-nav next="./end-users/GettingStarted.html"></fantomas-nav>
+<fantomas-nav next="{{fsdocs-next-page-link}}"></fantomas-nav>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -192,4 +192,4 @@ This update to the tree made it very straightforward to fix the original bug in

		Another example of code that could benefit from a better representation is [extern](https://github.com/fsprojects/fantomas/issues?q=is%3Aissue+is%3Aopen+extern).

		<fantomas-nav previous="./Conditional%20Compilation%20Directives.html" next="./The%20Missing%20Comment.html"></fantomas-nav>
		<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,4 +27,4 @@ There is currently [a known issue](https://github.com/fsprojects/fantomas/issues

		To workaround this in the meantime, you'll need to comment out the references to `Ionide.KeepAChangelog.Tasks` in `Directory.Build.props` and all of the `packages.lock.json` files, and then run `dotnet restore`. Please be careful not to include these changes when submitting a PR!

		<fantomas-nav next="./FSharp.html"></fantomas-nav>
		<fantomas-nav next="{{fsdocs-next-page-link}}"></fantomas-nav>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -61,4 +61,4 @@ A suite of end-to-end tests that run the actual `fantomas` command line applicat

		A suite of end-to-end tests that will verify the `Fantomas.Client` code against released versions of `fantomas`.

		<fantomas-nav previous="./Getting%20Started.html" next="./Transforming.html"></fantomas-nav>
		<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -102,4 +102,4 @@ let genSingleTextNode (node: SingleTextNode) = !-node.Text \|> genNode node

		`enterNode` and `leaveNode` will print the `TriviaNodes` using `genTrivia`.

		<fantomas-nav previous="./How%20Can%20I%20Contribute.html" next="./Multiple%20Times.html"></fantomas-nav>
		<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -87,4 +87,4 @@ The `dumpAndContinue` helper function can be used to inspect the `Context`.
		Please remove all usages when submitting a PR 😸.


		<fantomas-nav previous="./Transforming.html" next="./Formatted%20Code.html"></fantomas-nav>
		<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ Even if the tests are all green you should take a look at all the changes made t

		Think about tests to catch any regressions caused by the update and it's effects on Fantomas.

		<fantomas-nav previous="./Pull%20request%20ground%20rules.html" next="./Releases.html"></fantomas-nav>
		<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,4 @@ git diff --cached --name-only --diff-filter=ACM -z \| xargs -0 git add

		Please use with caution as [Fantomas is not without bugs](https://github.com/fsprojects/fantomas/issues?q=is%3Aissue+is%3Aopen+label%3A%22bug+%28soundness%29%22).

		<fantomas-nav previous="./FormattingCheck.html" next="./Rider.html"></fantomas-nav>
		<fantomas-nav previous="{{fsdocs-previous-page-link}}" next="{{fsdocs-next-page-link}}"></fantomas-nav>