Add mDNS network discovery docs
E.g. for DietPi-Dashboard: https://github.com/ravenclaw900/DietPi-Dashboard/issues/170 But actually, while I personally thought that a server admin web interface should probably not broadcast itself, this may be handy in many other cases. We could probably add a generic docs tab to all web UI software, or even all software with network interfaces or APIs, via Avahi daemon. As a next stage we could make the generation of these configs an option in dietpi-software itself, to be not too intrusive with additional prompts, via dietpi.txt option at least?
@MichaIng: What could we add at which docu section covering this issue? Recently, we added the Avahi section: Description for Avahi-Daemon added to Advanced Networking #1049.
Maybe we can add a little "tip" box to every web interface/access tab, like
You can make your DietPi/Home Assistant accessible via
<hostname>.local(default:DietPi.local), by installing Avahi-Daemon. See our Avahi-Daemon docs for details."
Um, we really need to make use of includes, else we just have so many code/text duplication for all of this: #402
mkdown Snippets: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
mkdown Snippets seem not to work with mkdocs tabs, i.e. including tabs via a snipped leads to a new tab in the docs.
You mean they cause a new tab row? Maybe empty lines or spaces matter. I am not sure how the end of one tab row and hence the beginning of a new one is obtained. Maybe the snippets syntax itself can and needs to be indented the same way the content of a the tab is.
The problem is the first line with the MD041 stuff.
This include file works:
=== "Transfer music to DietPi"
Make sure you have one of DietPi's [File Servers](file_servers.md) installed.
Default music directory:
- `/mnt/dietpi_userdata/Music`, `/Music` from NFS/Samba
This does not work:
<!-- markdownlint-disable MD041 -->
=== "Transfer music to DietPi"
Make sure you have one of DietPi's [File Servers](file_servers.md) installed.
Default music directory:
- `/mnt/dietpi_userdata/Music`, `/Music` from NFS/Samba
The only solution is to disable MD041 via the file markdownlint.yml.
Checking the docs, I think we can just put a .markdownlint.yml into. the snuppets-includes directory and disable the headings rule there.
Checking the docs, I think we can just put a
.markdownlint.ymlinto. thesnuppets-includesdirectory and disable the headings rule there.
👍 Good idea. Will test that.
✔️ Worked with https://github.com/MichaIng/DietPi-Docs/pull/1114/commits/2aca7ea348cd5129d1ec8e1549f8acc1381e0133