Update links to althack.dev and minor doc changes

README.md

@@ -1,7 +1,7 @@
 ![mkdocs-simple-plugin](https://github.com/athackst/mkdocs-simple-plugin/raw/main/media/mkdocs-simple-plugin.png)
 
 [![Test](https://github.com/athackst/mkdocs-simple-plugin/workflows/Test/badge.svg)](https://github.com/athackst/mkdocs-simple-plugin)
-[![Docs](https://github.com/athackst/mkdocs-simple-plugin/workflows/Docs/badge.svg)](https://athackst.github.io/mkdocs-simple-plugin) 
+[![Docs](https://github.com/athackst/mkdocs-simple-plugin/workflows/Docs/badge.svg)](https://althack.dev/mkdocs-simple-plugin) 
 [![Docker](https://img.shields.io/docker/pulls/althack/mkdocs-simple-plugin)](https://hub.docker.com/r/althack/mkdocs-simple-plugin) 
 [![pypi](https://img.shields.io/pypi/dm/mkdocs-simple-plugin?label=pypi%20downloads&color=blue)](https://pypi.org/project/mkdocs-simple-plugin/) 
 [![Github Action](https://img.shields.io/badge/github%20action-download-blue)](https://github.com/marketplace/actions/mkdocs-simple-action)
@@ -30,11 +30,11 @@ You may be wondering why you would want to generate a static site for your proje
 
     Finally, you may be interested in this plugin if you have a desire for easy-to-generate stylized documentation.  This plugin lets you take documentation you may already have -- either in markdown files or in your code -- and formats them into a searchable documentation website.  You can keep your documentation where it is (thank you very much).
 
-See [mkdocs-simple-plugin](https://athackst.github.io/mkdocs-simple-plugin/mkdocs_simple_plugin/plugin) for usage.
+See [mkdocs-simple-plugin](https://althack.dev/mkdocs-simple-plugin/mkdocs_simple_plugin/plugin) for usage.
 
 ## Contributing
 
-See the [contributing guide](https://athackst.github.io/mkdocs-simple-plugin/CONTRIBUTING)
+See the [contributing guide](https://althack.dev/mkdocs-simple-plugin/CONTRIBUTING)
 
 ## License
 

docker/README.md

@@ -1,6 +1,6 @@
 # Docker
 
-Use this image to create a [mkdocs](https://www.mkdocs.org/) site with the [mkdocs-simple-plugin](https://athackst.github.io/mkdocs-simple-plugin)
+Use this image to create a [mkdocs](https://www.mkdocs.org/) site with the [mkdocs-simple-plugin](https://althack.dev/mkdocs-simple-plugin)
 
 Using the docker image, you don't need to have the plugin or its dependencies installed on your system to build, test, and deploy a mkdocs generated site.
 

mkdocs.yml

@@ -6,10 +6,10 @@ plugins:
   - macros
   - search
   - mike
-hooks:
-  - examples/gen_readme.py
 edit_uri: ''
 site_url: https://althack.dev/mkdocs-simple-plugin
+hooks:
+  - examples/gen_readme.py
 repo_url: https://github.com/athackst/mkdocs-simple-plugin
 theme:
   name: material

mkdocs_simple_plugin/plugin.py

@@ -49,12 +49,14 @@
 You can add a `.mkdocsignore` file to ignore a directory or files by glob
 pattern.
 
+See [example mkdocsignore usage](../examples/ok-mkdocsignore/README.md)
+
 ## Default settings
 
 Below are the default settings of the plugin.
 
 ```yaml
-{{ mkdocs_simple_config }}
+{{ config.mkdocs_simple_config }}
 ```
 
 !!!Note
@@ -67,12 +69,14 @@
 
 ## Build
 
-Then, you can build the mkdocs from the command line.
+You can build mkdocs from the command line using the standard command
 
 ```bash
 mkdocs build
 ```
 
+or you can generate and build at the same time [see generator](generator.md).
+
 ## Run a local server
 
 One of the best parts of mkdocs is the ability to serve (and update!) your
@@ -347,7 +351,7 @@ def on_config(self, config: SimplePluginConfig, **kwargs):
         """Update configuration to use a temporary build directory."""
         default_config = dict((name, config_option.default)
                               for name, config_option in self.config_scheme)
-        self.mkdocs_simple_config = yaml.dump(
+        config.mkdocs_simple_config = yaml.dump(
             default_config,
             sort_keys=False,
             default_flow_style=False,

setup.py

@@ -14,10 +14,10 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     keywords='mkdocs readme wiki',
-    url='http://athackst.github.io/mkdocs-simple-plugin',
+    url='http://althack.dev/mkdocs-simple-plugin',
     project_urls={
         "Issues": "https://github.com/athackst/mkdocs-simple-plugin/issues",
-        "Documentation": "http://athackst.github.io/mkdocs-simple-plugin",
+        "Documentation": "http://althack.dev/mkdocs-simple-plugin",
         "Source Code": "https://github.com/athackst/mkdocs-simple-plugin",
     },
     author='Allison Thackston',

tests/test_generator.py

@@ -84,9 +84,9 @@ def test_site_url(self):
         """Test setting the site url."""
         self._test_env_setting(
             env_variable="SITE_URL",
-            env_value="https://athackst.github.io/mkdocs-simple-plugin/",
+            env_value="https://althack.dev/mkdocs-simple-plugin/",
             config_name="site_url",
-            config_value="https://athackst.github.io/mkdocs-simple-plugin/")
+            config_value="https://althack.dev/mkdocs-simple-plugin/")
 
     def test_site_dir(self):
         """Test setting the site url."""