githubmarkdown

How to embed code from repo in github markdown?

Is there a way of embedding the content of a file (from the projects repo) in Githubs markdown?

I have a code sample and want to embed it in the projects readme.

Solution

  • UPDATE:

    It turns out this is now possible if you paste a permalink of the code in your README.md file.

    To figure out how to get the permalink, check GitHub's docs on the topic. The permalink and the README.md needs to be in the same repository.

    OLD ANSWER:

    You can't do that currently. You will have to copy your code sample and paste it between triple ticks in your README file. Here is an example:

    ``` Ruby
class MyClass
end
```

    This will be static of course and you must update it manually when that code changes.