about-code / glossarify-md

A Term-to-Definition-Linker for Markdown. https://npmjs.com/package/glossarify-md
MIT License
30 stars 9 forks source link

User Story: Adding the glossary terms to a DOCX format and link to them instead of to the glossary.md #268

Closed gitopandi closed 1 year ago

gitopandi commented 1 year ago

Hi, here my user story_

As a academic book writer I would like glossarify-md to add the glossary terms to a word document before the first chapter in order to have linked glossary terms in the text which are linked to the terms in the same document and not to glossary.md.

Best regards Andreas

about-code commented 1 year ago

Thank you very much for your interest in glossarify-md and your user story. I am not sure to have understood your use case or workflow, already.

Are you authoring your book...

  1. ... using a text editor (e.g. VSCodium, Notepad / Notepad++, etc.) typing Markdown
    ... which you then convert to DOCX (e.g. using a tool like pandoc)
  2. ... using Microsoft Word or Open Office, primarily
    ... but looking for a way to manage your glossary in plaintext Markdown and then combining it with your word document?

In general glossarify-md may only be suited for a workflow of the kind of 1. but not 2. The tool can not analyze, search nor linkify DOCX input files but Markdown input files, only. It would then produce Markdown output files, again, which you had to post-process with a Markdown converter to gain a particular target format like DOCX. So it is more in favor of a LaTeX-like approach rather than intended to be used with an Office Suite.

If you are using a workflow like 1. I would be interested in your

about-code commented 1 year ago

Jaan Tollander de Balsch has written a tutorial on how you could approach scientific writing with Markdown (haven't tried myself). It outlines a toolchain and how to use pandoc and LaTeX to convert Markdown to PDF. Given that's a workstyle you feel comfortable with, then you may want to have a look at

Example: Frontmatter Syntax

---
title: Some title between frontmatter symbols --- indicating frontmatter syntax
date: 2023-04-07
---

Example: Math Syntax


Some Markdown with complicated formulas and equations

$$
f(a)={\frac {1}{2\pi i}}\oint _{\gamma }{\frac {f(z)}{z-a}}\,dz
$$

Example: Installing and configuring remark-math

npm install remark-math

glossarify-md.conf.json

{
   "baseDir": "./docs",
   "outDir" : "../docs-glossarified"
   "unified": {
      "plugins": {
         "remark-math": {}
      }
   }
}
about-code commented 1 year ago

Closing due to inactivity. Please reopen, if still relevant.