Fix asset reference to custom css (#106)

Merging since themes are broken. Docs failure is expected because it is introducing new pages.

.config/dictionary.txt

@@ -22,6 +22,7 @@ docstrings
 fontawesome
 htmlproofer
 inlinehilite
+libera
 linenums
 linkchecker
 linkcheckerrc

docs/README.md

@@ -1,3 +1,9 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
 # mkdocs-ansible theme
 
 This [mkdocs](https://www.mkdocs.org/) theme is based on [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) and aims to provide a consistent

docs/guide/contributor-guide.md

@@ -0,0 +1,56 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
+# Contributor Guide
+
+To contribute to `mkdocs-ansible` python package or to the list of tools part of it, please use pull requests on a branch of your own fork.
+
+After [creating your fork on GitHub], you can do:
+
+```shell-session
+$ git clone --recursive git@github.com:your-name/mkdocs-ansible
+$ cd mkdocs-ansible
+$ git checkout -b your-branch-name
+# DO SOME CODING HERE
+$ git add your new files
+$ git commit -v
+$ git push origin your-branch-name
+```
+
+You will then be able to create a pull request from your commit.
+
+Prerequisites:
+
+1. All fixes to core functionality (i.e. anything except docs or examples) should
+   be accompanied by tests that fail prior to your change and succeed afterwards.
+
+2. Before sending a PR, make sure that `tox -e lint` passes.
+
+Feel free to raise issues in the repo if you feel unable to contribute a code
+fix.
+
+## Talk to us
+
+Use Github [discussions] forum or for a live chat experience try
+`#ansible-devtools` IRC channel on libera.chat or Matrix room
+[#devtools:ansible.com](https://matrix.to/#/#devtools:ansible.com).
+
+For the full list of Ansible IRC and Mailing list, please see the [Ansible
+Communication] page. Release announcements will be made to the [Ansible
+Announce] list.
+
+Possible security bugs should be reported via email to
+<mailto:security@ansible.com>.
+
+## Code of Conduct
+
+Please see the official [Ansible Community Code of Conduct].
+
+[Discussions]: https://github.com/ansible/mkdocs-ansible/discussions
+[Ansible communication]: https://docs.ansible.com/ansible/latest/community/communication.html
+[Ansible announce]: https://groups.google.com/forum/#!forum/ansible-announce
+[Ansible Community Code of Conduct]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
+[Creating your fork on github]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects

mkdocs.yml

@@ -18,29 +18,34 @@ theme:
   name: ansible
   # custom_dir: src/mkdocs_ansible/.overrides
   features:
-    # - announce.dismiss
+    - announce.dismiss
     - content.action.edit
     - content.action.view
     - content.code.annotate
     - content.code.copy
-    # - content.tabs.link
+    - content.tabs.link
     - content.tooltips
-    # - header.autohide
-    # - navigation.expand
+    - header.autohide
+    - navigation.expand
     - navigation.footer
     - navigation.indexes
-    # - navigation.instant
-    # - navigation.prune
+    - navigation.instant
+    - navigation.path
+    - navigation.prune
     - navigation.sections
-    # - navigation.tabs
-    # - navigation.tabs.sticky
+    - navigation.tabs
+    - navigation.tabs.sticky
     - navigation.top
     - navigation.tracking
     - search.highlight
     - search.share
     - search.suggest
     - toc.follow
-    # - toc.integrate
+    - toc.integrate
+
+nav:
+  - Home: README.md
+  - Contributor Guide: guide/contributor-guide.md # Added folder structure here only to test that assets reference works fine
 
 # Plugins
 plugins:

src/mkdocs_ansible/main.html

@@ -1,3 +1,3 @@
 {% extends "base.html" %} {% block styles %} {{ super() }}
-<link rel="stylesheet" href="assets/stylesheets/ansible.css" />
+<link rel="stylesheet" href="{{ 'assets/stylesheets/ansible.css' | url }}" />
 {% endblock %}