Closed nwf closed 2 years ago
Just fixed the links (from _
to -
).
OK. This doesn't work in https://nodemcu.readthedocs.io/en/dev/modules/node/#nodeinput The link gets expanded to https://github.com/nodemcu/nodemcu-firmware/tree/dev/lua-modules/telnet/ Should be https://nodemcu.readthedocs.io/en/dev/lua-modules/telnet/
Oh, just realized we have the same issue on the BME280 math page.
Caused by this https://github.com/nodemcu/nodemcu-firmware/blob/release/docs/js/extra.js#L46
Staring at the code not knowing much about js it might be that adding a "/" to the relativePath might do the job. I assume that the dots are evaluated as wildcats matching any character. Thus effectively matching the intended start of "../../dev" but also "../lua-modules"
With the docs a lot of stuff isn't as it may seem - and much of it stems from the requirement of having links work both while browsing GitHub and inside the docs.
node.md
with have See [the telnet lua module](../lua-modules/telnet.md) for...
-> relative link 1 level up<p>See <a href="../../lua-modules/telnet/">the telnet lua module</a> for a working
-> relative link 2 levels up
../../
in the original .md
. This is used in links to .c
source files for example: [node.c](../../app/modules/node.c)
. MkDocs realizes those links point beyond the docs structure and keeps them as-is (rather than adding another level).Side note: in JavaScript the pattern in String.prototype.replace()
can be a string or a RegExp; we use it with a string.
See 8d091c476edf6ae2977a5f2a74bf5824d07d6183
dev
branch rather than for therelease
branch.docs/*
.