Hacker News new | ask | show | jobs
by robenkleene 2255 days ago
Love to hear any more commentary about the pros and cons of this approach? I assume the main reasoning is that it’s easier to make a link?

The nice thing about the `[File](file.md)` method is that it’s markdown native, e.g., you can follow them in GitHub, if you have a way to render file URLs HTML, you’re links will just work in the browser too, and many txt editors can follow them by default.
1 comments
apostacy 2255 days ago
The only time I would use the `[File](file.md)` syntax is if I'm specifically making documentation that will be published for other people.

Also, Github uses Gollum, which actually supports wiki style links anyway.

If you are maintaining a knowledge base, it gets really tedious to do that, if 99% of your links are just going to have the same caption as your filename. So being able to make links as quickly as possible facilitates efficiency. Besides, there are alternative syntaxes for being able to specific a custom caption for a wiki-style link.

Another thing to consider, is that in most mediums that I use my knowledge bases in, they are not styling my links anyway. I can still of course follow them automatically, but they are just presenting them as [[Links]]. Most people prefer that.

My different wikis have gone through many different iterations, and most of these engines are fairly compatible-ish with each other. They are similar enough that any migration required could be done with a few lines of Perl on my set of md files.

link
robenkleene 2255 days ago
Huh, ok I just tried this out and it doesn't work as well as I was hoping. It appears that that `[[A file]]` style works on GitHub Wikis but doesn't work in the repo browser itself (e.g., from the `README.md`)? That's a major limitation to me, because one of the big benefits of my approach is I get a free web version of every local Wiki that I have on GitHub.

I'm curious if you have another solution for actually publishing a `git` repo on the web using the `[[a file]]` link style?

link
apostacy 2253 days ago
Oh sorry, if you want it to work in your README.md, you have to specify the org-mode syntax. BTW it supporst org-mode syntax. Just have a README.org.
link
robenkleene 2255 days ago
Nice, lots of great tips here, you've made a strong enough case that I’m going to try out this approach myself. Thanks for sharing!
link