https://github.com/mandelsoft/mdgen

A Simple GitHub Markdown Generator able to consistently maintain a set of GitHub Markdown files.
https://github.com/mandelsoft/mdgen

generator github golang golang-application markdown

Last synced: about 1 month ago
JSON representation

A Simple GitHub Markdown Generator able to consistently maintain a set of GitHub Markdown files.

• Host: GitHub
• URL: https://github.com/mandelsoft/mdgen
• Owner: mandelsoft
• License: other
• Created: 2023-01-06T17:41:33.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-01-03T10:06:04.000Z (about 1 year ago)
• Last Synced: 2024-01-03T11:25:55.258Z (about 1 year ago)
• Topics: generator, github, golang, golang-application, markdown
• Language: Go
• Homepage:
• Size: 370 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Simple Markdown Generator

Have you every written a larger set of interconnected markdown files in

your github project? Then you will for sure have been stumbled over some major

pain points in markdown:

- Links are based on section headers and file locations

  You cannot just move a section form one file into another or even

  change the section header without invalidating the links

  all over the document tree.

- The different font sizes of section headers are nice but do not really

  help to understand the document structure, because the difference

  in the size is only recognizable in a direct comparison, but does

  no help to capture the document structure if there is text among

  the section titles.

- No more broken hyperlinks in your document tree?

- Are you missing section numbers? Manually maintaining numbers is possible,

  but then reorganizing of the structure is a hell. The numbers must be

  changed manually, and all the links are invalidated, again.

- Maintaining a common layout for description elements, which should

  look similar all over the document tree is a huge manual effort.

  For example describing structure fields or syntactical elements.

- You want to provide a highly interconnected document tree, where

  dedicated terms are always linked? Don't need to mention that this is a hell

  with pure markdown.

- You want to provide a glossary or a global table of contents?

If you feel comfortable with these problems, you can just forget about this

*Markdown Generator*.

 But if you want to get rid of this pain and want to concentrate on

the content instead of the form, then you should have a glimpse on this tool.

The [tool documentation](doc/README.md) is completely generated by this tool

from sources found in the `src` sub folder.