1

I've made a license for a program where I am working on.

My question is: is it possible to show a file (in my situation: license.md) as a readme.md in a github directory?

VonC
  • 1,042,979
  • 435
  • 3,649
  • 4,283

1 Answers1

1

Not in GitHub makrdown itself (see issues 172)

For now, we're not going to allow any includes in any of our markup formats.
There's just too much overhead to making sure that there are no security vulnerabilities in each of the markup formats we support.

It is possible with github pages built with Jekyll, or with some kind of preprocessing for markdown pages in general.

But there is no include with GitHub repo markdown files themselves.

In your case, it is best to generate your README.md by making sure its content include the latest revision of your LICENSE.md (for instance, through a pre-commit hook).

Community
  • 1
  • 1
VonC
  • 1,042,979
  • 435
  • 3,649
  • 4,283