Glossary Plugin
#2542
Replies: 1 comment 1 reply
-
This isn't really a direct solution to your issue (I guess) but there exists the Material for MkDocs has a documentation page explaining this extension and how it can be used effectively with the snippets extension from PyMdownX. https://squidfunk.github.io/mkdocs-material/reference/abbreviations/ This could allow you to write a collection of descriptions in a snippet to then include in the pages where necessary. |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Question
Hi, I am a newbie to mkdoc. I'm using mkdocs to write software specification documents.
(mkdocs is so useful. Thank you for developing it!)
The text I am writing is large, and there are many project-specific words in it.
For this reason, I would like to implement the following measures to make the documents easier to understand
I would like to automate the second steps because it would take a lot of time to do them manually. Is there any good way to do this?
Background/What I'm doing now
I am trying to create a plugin that will do 1. and 2. automatically.
The image of the process of this plugin is as follows
a. Parse meta-page info(*1) of all pages, and make map information between project-specific words and their description pages
b. In markdown text, Replace project-specific words with a link to their description page
But I can't seem to get these processes to map well to the events that the current mkdocs plugin receives.
Than you!
(*1)
Beta Was this translation helpful? Give feedback.
All reactions