Bump fsdocs-tool from 14.0.1 to 20.0.0

[dependabot[bot]]

trafficstars

Bumps fsdocs-tool from 14.0.1 to 20.0.0.

Changelog

Sourced from fsdocs-tool's changelog.

20.0.0 - 2024-02-14

Stable release

20.0.0-beta-002 - 2024-02-08

Fixed

• Avoid theme flicker in dark mode. #901

20.0.0-beta-001 - 2024-01-31

Changed

• Marking development of v20 as complete.

20.0.0-alpha-019 - 2024-01-29

Fixed

• Use dvh for full viewport height . #899

20.0.0-alpha-018 - 2024-01-10

Fixed

• Add -webkit-text-size-adjust. #889

20.0.0-alpha-017 - 2024-01-09

Fixed

• Set default font-size for code. #889

20.0.0-alpha-016 - 2023-12-07

Fixed

• Use empty replacement for {{fsdocs-meta-tags} in API doc pages. #892

20.0.0-alpha-015 - 2023-12-06

Fixed

• Namespace description overflows content box. #886

Added

• SEO-optimization for new theme. Allow description and keywords in frontmatter. Introduce {{fsdocs-meta-tags}}. #869

20.0.0-alpha-014 - 2023-11-22

Added

• Added the ability to use ipynb files as inputs #874

Fixed

• Fsx outputs no longer treat inline html as F# code. Inline html blocks are now enclosed inside literate comments.

... (truncated)

Upgrade guide

Sourced from fsdocs-tool's upgrade guide.

---

category: Advanced categoryindex: 3 index: 1

Upgrading to fsdocs

Here are the typical steps to upgrade a repo based on ProjectScaffold to use fsdocs

1. Run

   [lang=text]
   dotnet new tool
   dotnet tool install fsdocs-tool
   

2. Delete all of docs\tools particularly docs\tool\generate.fsx. Keep a copy of any templates for reference as you'll have to copy some bits across to the new template.

3. Put your docs directory so it reflects the final shape of the site. For example move the content of docs\input\* and docs\files\* directly to docs\*

4. Follow the notes in styling to start to style your site.

5. Run

   [lang=text]
   dotnet fsdocs watch
   

   and edit and test your docs.

6. If using FAKE adjust build.fsx e.g.

   [lang=text]
   Target.create "GenerateDocs" (fun _ ->
      Shell.cleanDir ".fsdocs"
      DotNet.exec id "fsdocs" "build --clean" |> ignore
   )
   Target.create "ReleaseDocs" (fun _ ->
   Git.Repository.clone "" projectRepo "temp/gh-pages"
   Git.Branches.checkoutBranch "temp/gh-pages" "gh-pages"
   Shell.copyRecursive "output" "temp/gh-pages" true |> printfn "%A"
   Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" "add ." |> printfn "%s"
   let cmd = sprintf """commit -a -m "Update generated documentation for version %s""" release.NugetVersion
   Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
   Git.Branches.push "temp/gh-pages"
   )
   

7. Consider creating docs\_template.fsx and docs\_template.ipynb to enable co-generation of F# scripts and F# notebooks.

   If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example like this.

... (truncated)

Commits

• See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)