Skip to content

Instantly share code, notes, and snippets.

@ingydotnet

ingydotnet/Feature:README-extension.md

Last active December 26, 2015 18:08
Show Gist options
  • Save ingydotnet/7191728 to your computer and use it in GitHub Desktop.
Save ingydotnet/7191728 to your computer and use it in GitHub Desktop.
Download ZIP
Feature request: README extensions detected from symlink
Raw
Feature:README-extension.md

Hi guys,

I always hated that I have to add a filetype extension like .markdown or whatever. It would be nice if there was another way to detect the filetype, and just call the file README.

I just thought of a way to do this where nobody loses.

I often symlink my README.md file to a file call doc/my-project.md. And you guys render that as markdown. Great!

Since it's a symlink you can get the extension from the referent file (doc/whatever.ext) and I can call the file just README!

There's no possibility to get it wrong, and I can go back to the normal README style I gre up with.

What do you think?

Cheers, Ingy döt Net

Personal Bug Tracking Reference Gist: https://gist.github.com/ingydotnet/7191728

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment