|
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.
EDIT -
I can find documentation on how to use bloody emojis but put an id for a link into the doc? No bloody way!
veni bibi saltavi
|
|
|
|
|
Give'em a plain text file and tell them to like it.
Tired of cottonin' to these whippersnappers.
|
|
|
|
|
I'd almost agree if it wasn't for the fact that I like linkies!
veni bibi saltavi
|
|
|
|
|
Use HTML?
Skipper: We'll fix it.
Alex: Fix it? How you gonna fix this?
Skipper: Grit, spit and a whole lotta duct tape.
|
|
|
|
|
Can't you manually name the pieces of heading with something like
[EX01]
## Something
### Old
[EX02]
## Something
### New ?
DURA LEX, SED LEX
GCS d--- s-/++ a- C++++ U+++ P- L- E-- W++ N++ o+ K- w+++ O? M-- V? PS+ PE- Y+ PGP t++ 5? X R++ tv-- b+ DI+++ D++ G e++>+++ h--- ++>+++ y+++* Weapons extension: ma- k++ F+2 X
If you think 'goto' is evil, try writing an Assembly program without JMP. -- TNCaver
When I was six, there were no ones and zeroes - only zeroes. And not all of them worked. -- Ravi Bhavnani
|
|
|
|
|
## This
### <a name="this-syntax"></a> Syntax
### <a name="this-example"></a> Example
## That
### <a name="that-syntax"></a> Syntax
### <a name="that-example"></a> Example
To link to these:
Take me to [This/Syntax](#this-syntax)
Skipper: We'll fix it.
Alex: Fix it? How you gonna fix this?
Skipper: Grit, spit and a whole lotta duct tape.
|
|
|
|
|
That's what it looks like, but I think it stinketh like a ham and camembert roll left in sealed sandwich box on a south facing window sill for four day.
veni bibi saltavi
|
|
|
|
|
It is markdown! What do you expect?!
Skipper: We'll fix it.
Alex: Fix it? How you gonna fix this?
Skipper: Grit, spit and a whole lotta duct tape.
|
|
|
|
|
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
|
|
|
|
|
Markdown is something that should just crawl into a deep hole and die.
Marc
|
|
|
|
|
So basically markdown makes Marc down.
veni bibi saltavi
|
|
|
|
|
Nagy Vilmos wrote: So basically markdown makes Marc down.
Well, actually it makes me murderous, but that doesn't work out too well, either as a pun or as a life achievement. 
Marc
|
|
|
|
|
Jeremy Falcon
|
|
|
|
|
Marc Clifton wrote: Markdown is something that should just crawl into a deep hole and die.
Absolutely 100% agree!!
As if we didn't learn HTML MARKUP for a reason. Now, I need to learn proprietary markdown!?! Ugh.
I know, sites are attempting to store markdown in databases and DBs don't allow markup to be stord for security reasons. It's still annoying. 
|
|
|
|
|
For what? It serves its purpose well. Can't go be afraid of change.
Jeremy Falcon
|
|
|
|
|
Jeremy Falcon wrote: For what? It serves its purpose well
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!
Marc
|
|
|
|
|
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.
Jeremy Falcon
|
|
|
|
|
Jeremy Falcon wrote: but for simple stuff it reminds me a lot of Wiki editing.
Ah, that's what it reminds me of too. I haven't done wiki editing in years, forgot about that.
Marc
|
|
|
|
|
Just wait until they make you write wiki's in markdown. 
Jeremy Falcon
|
|
|
|
|
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".
|
|
|
|
|
The drive-by down-voter seems to be back. (the Leslie part)
In case he/she/it happens to read this: "Meh . . ."
Since I'm known to be an attention seeker, any attention is good. Choke on that for a while!
| Ravings en masse^ |
|---|
| "The difference between genius and stupidity is that genius has its limits." - Albert Einstein | | "If you are searching for perfection in others, then you seek disappointment. If you are seek perfection in yourself, then you will find failure." - Balboos HaGadol Mar 2010 |
|
|
|
|
|
Why post something at all if nobody replies and gives you some attention? Therefore anyone who posts here seeks attention.
The language is JavaScript. that of Mordor, which I will not utter here
This is Javascript. If you put big wheels and a racing stripe on a golf cart, it's still a f***ing golf cart.
"I don't know, extraterrestrial?"
"You mean like from space?"
"No, from Canada."
If software development were a circus, we would all be the clowns.
|
|
|
|
|
OK - I'm listening . . .
| Ravings en masse^ |
|---|
| "The difference between genius and stupidity is that genius has its limits." - Albert Einstein | | "If you are searching for perfection in others, then you seek disappointment. If you are seek perfection in yourself, then you will find failure." - Balboos HaGadol Mar 2010 |
|
|
|
|
|
Do you really want me to rant about my latest doctrine on 8 bit computer design?
The language is JavaScript. that of Mordor, which I will not utter here
This is Javascript. If you put big wheels and a racing stripe on a golf cart, it's still a f***ing golf cart.
"I don't know, extraterrestrial?"
"You mean like from space?"
"No, from Canada."
If software development were a circus, we would all be the clowns.
|
|
|
|
|
Really? Tell me more! It seems this problem may have started some time ago - perhaps in your childhood? 0xF0r what it's worth, new meds for 8-bit trauma are still under development. Just hold on a little bit longer.
| Ravings en masse^ |
|---|
| "The difference between genius and stupidity is that genius has its limits." - Albert Einstein | | "If you are searching for perfection in others, then you seek disappointment. If you are seek perfection in yourself, then you will find failure." - Balboos HaGadol Mar 2010 |
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
