Add a url to video file in your ReadMe. Github now supports videos, see more detailed answer here: https://stackoverflow.com/a/4279746/1092815 You can see a live example here (See at the end of the readme): https://github.com/alelievr/Mixture/blob/0.4.0/README.md Github Pages I strongly recommend placing the video in a project website created with GitHub Pages instead of the readme, like … Read more
Interpreting newlines as <br /> used to be a feature of Github-flavored markdown, but the most recent help document no longer lists this feature. Fortunately, you can do it manually. The easiest way is to ensure that each line ends with two spaces. So, change a b c into a__ b__ c (where _ is … Read more
I followed an example in another repository and wrapped the directory structure within a pair of triple backticks (“`): “` project │ README.md │ file001.txt │ └───folder1 │ │ file011.txt │ │ file012.txt │ │ │ └───subfolder1 │ │ file111.txt │ │ file112.txt │ │ … │ └───folder2 │ file021.txt │ file022.txt “`
See the original markdown specification (bold mine): The implication of the “one or more consecutive lines of text” rule is that Markdown supports “hard-wrapped” text paragraphs. This differs significantly from most other text-to-HTML formatters (including Movable Type’s “Convert Line Breaks” option) which translate every line break character in a paragraph into a <br /> tag. … Read more
.md is markdown. README.md is used to generate the html summary you see at the bottom of projects. Github has their own flavor of Markdown. Order of Preference: If you have two files named README and README.md, the file named README.md is preferred, and it will be used to generate github’s html summary. FWIW, Stack … Read more
Showing gifs need two things 1- Use this syntax as in these examples  Yields: 2- The image url must end with gif 3- For posterity: if the .gif link above ever goes bad, you will not see the image and instead see the alt-text and URL, like this: 4- for resizing the gif … Read more
Use an HTML line break (<br />) to force a line break within a table cell: | something | something that’s rather long and <br />goes on for a very long time | something else | |———–|—————————————————————|—————-| Rendered: something something that’s rather long and goes on for a very long time something else
It’s not possible to embed videos directly, but you can put an image which links to a YouTube video: [](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE) For more information about Markdown look at this Markdown cheatsheet on GitHub. For more information about Youtube image links look this question.
I wrote a small CLI in Python and added GFM support. It’s called Grip (Github Readme Instant Preview). Install it with: $ pip install grip And to use it, simply: $ grip Then visit localhost:5000 to view the readme.md file at that location. You can also specify your own file: $ grip CHANGES.md And change … Read more
One way to add color to a README is by utilising a service that provides placeholder images. For example this Markdown can be used: –  `#f03c15` –  `#c5f015` –  `#1589F0` To create a list of any colors you like: #f03c15 #c5f015 #1589F0