Skip to content

Commit d8d42f2

Browse files
Fix asset reference to custom css
1 parent 22aed1e commit d8d42f2

File tree

4 files changed

+77
-10
lines changed

4 files changed

+77
-10
lines changed

docs/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
17
# mkdocs-ansible theme
28

39
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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
7+
# Contributor Guide
8+
9+
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.
10+
11+
After [creating your fork on GitHub], you can do:
12+
13+
```shell-session
14+
$ git clone --recursive [email protected]:your-name/mkdocs-ansible
15+
$ cd mkdocs-ansible
16+
$ git checkout -b your-branch-name
17+
# DO SOME CODING HERE
18+
$ git add your new files
19+
$ git commit -v
20+
$ git push origin your-branch-name
21+
```
22+
23+
You will then be able to create a pull request from your commit.
24+
25+
Prerequisites:
26+
27+
1. All fixes to core functionality (i.e. anything except docs or examples) should
28+
be accompanied by tests that fail prior to your change and succeed afterwards.
29+
30+
2. Before sending a PR, make sure that `tox -e lint` passes.
31+
32+
Feel free to raise issues in the repo if you feel unable to contribute a code
33+
fix.
34+
35+
## Talk to us
36+
37+
Use Github [discussions] forum or for a live chat experience try
38+
`#ansible-devtools` IRC channel on libera.chat or Matrix room
39+
[#devtools:ansible.com](https://matrix.to/#/#devtools:ansible.com).
40+
41+
For the full list of Ansible IRC and Mailing list, please see the [Ansible
42+
Communication] page. Release announcements will be made to the [Ansible
43+
Announce] list.
44+
45+
Possible security bugs should be reported via email to
46+
47+
48+
## Code of Conduct
49+
50+
Please see the official [Ansible Community Code of Conduct].
51+
52+
[Discussions]: https://github.com/ansible/mkdocs-ansible/discussions
53+
[Ansible communication]: https://docs.ansible.com/ansible/latest/community/communication.html
54+
[Ansible announce]: https://groups.google.com/forum/#!forum/ansible-announce
55+
[Ansible Community Code of Conduct]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
56+
[Creating your fork on github]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects

mkdocs.yml

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,34 @@ theme:
1818
name: ansible
1919
# custom_dir: src/mkdocs_ansible/.overrides
2020
features:
21-
# - announce.dismiss
21+
- announce.dismiss
2222
- content.action.edit
2323
- content.action.view
2424
- content.code.annotate
2525
- content.code.copy
26-
# - content.tabs.link
26+
- content.tabs.link
2727
- content.tooltips
28-
# - header.autohide
29-
# - navigation.expand
28+
- header.autohide
29+
- navigation.expand
3030
- navigation.footer
3131
- navigation.indexes
32-
# - navigation.instant
33-
# - navigation.prune
32+
- navigation.instant
33+
- navigation.path
34+
- navigation.prune
3435
- navigation.sections
35-
# - navigation.tabs
36-
# - navigation.tabs.sticky
36+
- navigation.tabs
37+
- navigation.tabs.sticky
3738
- navigation.top
3839
- navigation.tracking
3940
- search.highlight
4041
- search.share
4142
- search.suggest
4243
- toc.follow
43-
# - toc.integrate
44+
- toc.integrate
45+
46+
nav:
47+
- Home: README.md
48+
- Contributor Guide: guide/contributor-guide.md # Added folder structure here only to test that assets reference works fine
4449

4550
# Plugins
4651
plugins:

src/mkdocs_ansible/main.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{% extends "base.html" %} {% block styles %} {{ super() }}
2-
<link rel="stylesheet" href="assets/stylesheets/ansible.css" />
2+
<link rel="stylesheet" href="{{ 'assets/stylesheets/ansible.css' | url }}" />
33
{% endblock %}

0 commit comments

Comments
 (0)