Update docs

- Add sitemap
- Add GitHub link and badges
- Delete API docs before building

README.md

@@ -3,6 +3,7 @@
 [![NuGet Release][nuget image]][nuget url]
 [![Build Status](https://github.com/searchpioneer/lingua-dotnet/actions/workflows/dotnet.yml/badge.svg)](https://github.com/searchpioneer/lingua-dotnet/actions/workflows/dotnet.yml)
 [![license badge][license badge]][license url]
+[![docs][docs badge]][docs url]
 
 Ranklib for .NET is a hardened port to .NET of [RankLib](https://sourceforge.net/p/lemur/wiki/RankLib/),
 a popular open source learning to rank library written in Java. It maintains compatibility with input and output
@@ -72,4 +73,6 @@ The following metrics are implemented to measure the effectiveness of ranking
 [nuget url]: https://www.nuget.org/packages/SearchPioneer.RankLib/
 [nuget image]: https://img.shields.io/nuget/v/SearchPioneer.RankLib.svg
 [license badge]: https://img.shields.io/badge/license-Apache%202.0-blue.svg
-[license url]: https://www.apache.org/licenses/LICENSE-2.0
+[license url]: https://www.apache.org/licenses/LICENSE-2.0
+[docs badge]: https://img.shields.io/badge/documentation-gray.svg
+[docs url]: https://searchpioneer.github.io/ranklib-dotnet

build/Build/Program.cs

@@ -69,6 +69,10 @@
 
 	Target(Docs, () =>
 	{
+		foreach (var file in Directory.EnumerateFiles("docs/Docs/api")
+			         .Where(file => file.EndsWith(".yml") || file.EndsWith(".manifest")))
+			File.Delete(file);
+
 		Run("docfx", "docs/Docs/docfx.json --serve");
 	});
 

docs/Docs/docfx.json

@@ -48,6 +48,11 @@
       "_lang": "en",
       "_enableSearch": true
     },
+    "sitemap": {
+      "baseUrl": "https://searchpioneer.github.io/ranklib-dotnet/",
+      "priority": 0.1,
+      "changefreq": "daily"
+    },
     "template": [
       "default",
       "modern",

docs/Docs/documentation/installation.md

@@ -22,5 +22,5 @@ dotnet tool install -g SearchPioneer.RankLib.Cli --prerelease
 To see all the commands supported by the command line tool
 
 ```sh
-dotnet-ranklib --help~~~~
+dotnet-ranklib --help
 ```

docs/Docs/index.md

@@ -48,4 +48,4 @@ The following metrics are implemented to measure the effectiveness of ranking
 [nuget url]: https://www.nuget.org/packages/SearchPioneer.RankLib/
 [nuget image]: https://img.shields.io/nuget/v/SearchPioneer.RankLib.svg
 [license badge]: https://img.shields.io/badge/license-Apache%202.0-blue.svg
-[license url]: https://www.apache.org/licenses/LICENSE-2.0
+[license url]: https://www.apache.org/licenses/LICENSE-2.0

docs/Docs/template/public/main.js

@@ -0,0 +1,9 @@
+export default {
+  iconLinks: [
+    {
+      icon: 'github',
+      href: 'https://github.com/searchpioneer/ranklib-dotnet',
+      title: 'GitHub'
+    }
+  ]
+}