Change name to darkerfx + other misc changes

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "Steffen",
+        "Wilke",
+        "darkerfx"
+    ]
+}

Makefile

@@ -6,6 +6,9 @@ all: docs
 docs: docfx/docfx.exe
 	./docfx/docfx.exe docs/docfx.json
 
+docs-screenshot:
+	wkhtmltoimage --crop-h 768 http://localhost:8080/articles/intro.html docs/images/darkfx-screenshots.png
+
 # This depends on live-server being available. Install like this (presumed
 # Node.js already being available):
 #

README.md

@@ -1,26 +1,32 @@
-# darkFX - A dark theme for DocFX!
+# darkerfx - A dark theme for DocFX!
+
 A dark template for documentation generated with [DocFX](https://dotnet.github.io/docfx/).
-This is an override of the default template so you need to enable both in the `docfx.json`.
+
+The theme is created as an override of the default template, so both `default` and `darkerfx` needs to be enabled in `docfx.json`
+
+Here is an example of what it looks like:
 
 ![darkFX - Screenshots](./docs/images/darkfx-screenshots.png)
 
 ## Live Demo
-You can view a demo DocFX project with this template [HERE](https://steffen-wilke.github.io/darkfx/).
+You can view a demo DocFX project with this template [HERE](https://perlun.github.io/darkerfx/).
 
 ## Install
 
-1. Download the source or the zipped file from the [releases](https://github.com/steffen-wilke/darkfx/releases).
+1. Download the source or the zipped file from the [releases](https://github.com/perlun/darkerfx/releases).
 2. Create a `templates` folder in the root of your DocFX directory.
-3. Copy the `darkfx` folder to the `templates` folder.
-4. Update the `docfx.json` configuration to include the darkfx template:
+3. Copy the `darkerfx` folder to the `templates` folder.
+4. Update the `docfx.json` configuration to include the `darkerfx` template:
     ```json
     {
         "template": [
             "default",
-            "templates/darkfx"
+            "templates/darkerfx"
         ],
     }
     ```
-    
+
 ## Acknowledgement
-Many thanks to [Oscar Vásquez](https://github.com/ovasquez) from which I borrowed the example pages and repository structure of his [Material Theme for DocFX](https://github.com/ovasquez/docfx-material).
+The theme is based on the great [darkFX](https://github.com/steffen-wilke/darkfx) theme by Steffen Wilke. Many thanks to you!
+
+darkFX in turn has the following acknowledgement: Many thanks to [Oscar Vásquez](https://github.com/ovasquez) from which I borrowed the example pages and repository structure of his [Material Theme for DocFX](https://github.com/ovasquez/docfx-material).

docs/docfx.json

@@ -24,17 +24,17 @@
     "fileMetadataFiles": [],
     "template": [
       "default",
-      "../darkfx"
+      "../darkerfx"
     ],
     "postProcessors": [
       "ExtractSearchIndex"
     ],
     "globalMetadata": {
-      "_appFooter": "<span>Copyright © Steffen Wilke<br>Generated with <strong>DocFX</strong></span>",
+      "_appFooter": "<span>Copyright © Steffen Wilke & Per Lundberg<br>Generated with <strong>DocFX</strong></span>",
       "_appTitle": "darkFX",
       "_enableSearch": "true",
       "_gitContribute": {
-        "repo": "https://github.com/steffen-wilke/docfx-dark"
+        "repo": "https://github.com/perlun/darkerfx"
       },
       "_gitUrlPattern": "github"
     },

docs/index.md

@@ -1,23 +1,28 @@
-# darkFX - A dark theme for DocFX!
+# darkerfx - A dark theme for DocFX!
+
 A dark template for documentation generated with [DocFX](https://dotnet.github.io/docfx/).
-This is an override of the default template so you need to enable both in the `docfx.json`.
 
-![darkFX - Screenshots](./images/darkfx-screenshots.png)
+The theme is created as an override of the default template, so both `default` and `darkerfx` needs to be enabled in `docfx.json`
+
+## Live Demo
+You can view a demo DocFX project with this template [HERE](https://perlun.github.io/darkerfx/).
 
 ## Install
 
-1. Download the source or the zipped file from the [releases](https://github.com/steffen-wilke/darkfx/releases).
+1. Download the source or the zipped file from the [releases](https://github.com/perlun/darkerfx/releases).
 2. Create a `templates` folder in the root of your DocFX directory.
-3. Copy the `darkfx` folder to the `templates` folder.
-4. Update the `docfx.json` configuration to include the material template:
+3. Copy the `darkerfx` folder to the `templates` folder.
+4. Update the `docfx.json` configuration to include the `darkerfx` template:
     ```json
     {
         "template": [
             "default",
-            "templates/darkfx"
+            "templates/darkerfx"
         ],
     }
     ```
 
 ## Acknowledgement
-Many thanks to [Oscar Vásquez](https://github.com/ovasquez) from which I borrowed the example pages and repository structure of his [Material Theme for DocFX](https://github.com/ovasquez/docfx-material).
+The theme is based on the great [darkFX](https://github.com/steffen-wilke/darkfx) theme by Steffen Wilke. Many thanks to you!
+
+darkFX in turn has the following acknowledgement: Many thanks to [Oscar Vásquez](https://github.com/ovasquez) from which I borrowed the example pages and repository structure of his [Material Theme for DocFX](https://github.com/ovasquez/docfx-material).

docs/toc.yml

@@ -4,4 +4,4 @@
   href: api/
   topicHref: api/index.md
 - name: GitHub
-  href: https://github.com/steffen-wilke/darkfx/
+  href: https://github.com/perlun/darkerfx/