The Lounge is rated PG. If you're about to post something you wouldn't want your
kid sister to read then don't post it. No flame wars, no abusive conduct, no programming
questions and please don't post ads.
If markdown is 'programming' then slap my thigh and call me Beryl.
I'm writing a rather long README.md for some inhouse tools we user for our software. I want a single file that everyone [well the other four people for now] can go to with all the syntax and explanations. The one thing that is now haunting me is putting in links. Why you cry Vilmos?
What the doc looks like is:
## This ### Syntax ### Example ## That ### Syntax ### Example
Because the headings have the same text they end up with the same id and I can't link to them. Anyone know what I should do. Our repos are on github if that will make a difference.
I can find documentation on how to use bloody emojis but put an id for a link into the doc? No bloody way!
Use something unique for each "Syntax" and each "Example" ... derrr
#SupportHeForShe Government can give you nothing but what it takes from somebody else. A government big enough to give you everything you want is big enough to take everything you've got, including your freedom.-Ezra Taft Benson You must accept 1 of 2 basic premises: Either we are alone in the universe or we are not alone. Either way, the implications are staggering!-Wernher von Braun
Why do we need another formatting definition with obscure syntax? What ever happened to a nice WYSIWYG editor? And every site I've used markdown on, there are enough variations that something I learned how to do on one site doesn't work on another.
Jeremy Falcon wrote:
Can't go be afraid of change.
True, but I can complain when change is taking two steps backwards and zero forwards!
Well, it's lightweight. Just look most generated HTML from a WYSIWYG editor. I think it's great for non-techy people or stuff like quick readmes. I'd not make a webpage with it, but for simple stuff it reminds me a lot of Wiki editing.
I recently ran into the same problem on GitHub. I couldn't figure it out so I used the Wiki tab to create the documentation so I could easily add links via regular HTML MARKUP. The readme was quite annoying and a waste of time to learn how to use special markdown when I know markup.
Oh, my readme says, "Check out the Wiki tab for more info".