-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add maindir
nimdoc configuration item that points to the directory of theindex.html
#19856
base: devel
Are you sure you want to change the base?
Conversation
…of theindex.html This is done to support global links in the documentation's menu in the nimdoc.cfg as follows: <ul class="simple-boot"> <li><a href="$maindir/index.html">Index</a></li> <li><a href="$maindir/mydoc.html">My documentation</a></li> <li><a href="$theindexhref">Generated index</a></li> </ul> Using this $maindir configuration item, one might even get rid of the $theindexhref and use $maindir/theindex.html instead.
Nice but please add a test case for this or patch an existing one. |
Hi @Araq, thank you very much for your quick response! Please note I am still quite new to Nim so I would be happy to get some pointers here. I would be happy to add a corresponding test, but could not find a valuable examples on how to craft it. |
Look at |
I now use the following entry in |
This pull request is stale because it has been open for 1 year with no activity. Contribute more commits on the pull request and rebase it on the latest devel, or it will be closed in 30 days. Thank you for your contributions. |
This pull request has been marked as stale and closed due to inactivity after 395 days. |
This is done to support global links in the documentation's menu in the nimdoc.cfg as follows:
Using this $maindir configuration item, one might even get rid of the $theindexhref and use $maindir/theindex.html instead.