v1.0.0 +semver: major

README.md

@@ -31,3 +31,5 @@ Tool to generate markdown from C# XML documentation, based on [MarkdownGenerator
 ```shell
 > xmldoc2md -h
 ```
+
+See complete documentation [here](https://charlesdevandiere.github.io/xmldoc2md/).

docs/README.md

@@ -2,7 +2,7 @@
 
 Tool to generate markdown from C# XML documentation, based on [MarkdownGenerator](https://github.com/neuecc/MarkdownGenerator) project.
 
-See generated sample documentation [here](sample).
+See sample generated documentation [here](sample).
 
 ## How to use
 
@@ -28,4 +28,17 @@ See generated sample documentation [here](sample).
 
 ```shell
 > xmldoc2md -h
+
+Usage: xmldoc2md [arguments] [options]
+
+Arguments:
+  src  DLL source path
+  out  Output directory
+
+Options:
+  -v|--version               Show version information
+  -?|-h|--help               Show help information
+  --namespace-match <regex>  Regex pattern to select namespaces
+  --index-page-name <regex>  Name of the index page (default: "index")
+
 ```

docs/_config.yml

@@ -1 +1,2 @@
-theme: jekyll-theme-cayman
+theme: jekyll-theme-cayman
+show_downloads: true

docs/sample/MyClassLib.SubNamespace/GenericClass{T}.md

@@ -16,4 +16,4 @@ public class GenericClass<T>
 
 ---
 
-[`< Back`](./)
+[`< Back`](../)

docs/sample/MyClassLib.SubNamespace/SubClass.md

@@ -17,4 +17,4 @@ public class SubClass
 
 ---
 
-[`< Back`](./)
+[`< Back`](../)

docs/sample/_config.yml

@@ -0,0 +1,5 @@
+theme: jekyll-theme-cayman
+title: MyClassLib
+description:
+github.is_project_page: false
+show_downloads: false

docs/sample/index.md

@@ -1,10 +1,10 @@
-# References
+# MyClassLib
 
-## MyClassLib
+## `MyClassLib`
 
 - [`Class1`](MyClassLib/Class1)
 
-## MyClassLib.SubNamespace
+## `MyClassLib.SubNamespace`
 
 - [`GenericClass<T>`](MyClassLib.SubNamespace/GenericClass{T})
 - [`SubClass`](MyClassLib.SubNamespace/SubClass)

src/XMLDoc2Markdown/MarkdownGenerator.cs

@@ -206,7 +206,7 @@ public override string ToString()
 
             mb.AppendLine("---");
             mb.AppendLine();
-            mb.Link(MarkdownBuilder.MarkdownCodeQuote("< Back"), "./");
+            mb.Link(MarkdownBuilder.MarkdownCodeQuote("< Back"), "../");
             mb.AppendLine();
 
             return mb.ToString();

src/XMLDoc2Markdown/Program.cs

@@ -12,7 +12,7 @@ class Program
         static void Main(string[] args)
         {
             var app = new CommandLineApplication();
-            app.Name = "MarkdownGenerator";
+            app.Name = "xmldoc2md";
 
             app.VersionOption("-v|--version", () =>
             {
@@ -33,17 +33,17 @@ static void Main(string[] args)
                 "Regex pattern to select namespaces",
                 CommandOptionType.SingleValue);
 
-            CommandOption homePageNameOption = app.Option(
-                "--home-page-name <regex>",
-                "Name of the home page",
+            CommandOption indexPageNameOption = app.Option(
+                "--index-page-name <regex>",
+                "Name of the index page (default: \"index\")",
                 CommandOptionType.SingleValue);
 
             app.OnExecute(() =>
             {
                 string src = srcArg.Value;
                 string @out = outArg.Value;
                 string namespaceMatch = namespaceMatchOption.Value();
-                string homePageName = homePageNameOption.HasValue() ? homePageNameOption.Value() : "README";
+                string indexPageName = indexPageNameOption.HasValue() ? indexPageNameOption.Value() : "index";
 
                 var xmlDocumentation = new XmlDocumentation(src, namespaceMatch);
 
@@ -73,7 +73,7 @@ static void Main(string[] args)
                     }
                 }
 
-                File.WriteAllText(Path.Combine(@out, $"{homePageName}.md"), indexBuilder.ToString());
+                File.WriteAllText(Path.Combine(@out, $"{indexPageName}.md"), indexBuilder.ToString());
 
                 return 0;
             });