Replies: 1 comment
-
I like option 1. It is centralized and easy enough to maintain. It also provides a clear entrypoint to the catalogue of applications your teams are dealing with. Option 2 is not possible afaik - as you mentioned, abbreviations can only contain plain text and won't render additional Markdown. Another alternative would be to use Annotations, as they can contain Markdown (e.g. links), and can be used pretty much anywhere. One option to automatically add these annotations to each occurrence of, let's say, Salesforce being mentioned in your docs would be good old |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Pretty new to Mkdocs-material and mkdocs in general, so I hope what I'm asking is relatively simple. Instead of asking a pointed question, i'll tell you what the problem is and maybe someone here can explain how they would solve it with mkdocs-material.
In our business there are literally hundreds of login pages to different applications and finding the hidden url to said login page can be really time consuming and difficult. It's getting better with Okta centralizing some things, but there is still enough not in Okta that its a problem.
So I'm trying ot find a creative way to use Mkdocs which is my teams document site to make it easier to quickly find these login urls. Here are the ideas I have right now:
Use a datatable on a single page that you can go to find these links
Use the abbr and snippets plugin to make the application names on hover in any documentation show the link (I haven't been able to do this, it feels that my abbreviations.md file can only have basic tooltip content and not markdown with links
Similar to above, but maybe can resolve my markdown issue by using the abbreviations.md along with a snippet for each application that makes a more detailed tooltip that is automatic on all pages where that application is mentioned? I tried this and it didn't work.
includes/abbreviations.md
includes/snippet_links.md:
Last idea is to make some sort of dropdown menu in top-nav that has these shortcuts, but the basic configuration of the nav and with awesome-nav doesn't really support this so would likely be pretty highly custom.
So far none of these great ideas seem to be great.
Beta Was this translation helpful? Give feedback.
All reactions