× {{alert.msg}} Never ask again
Get notified about new tutorials RECEIVE NEW TUTORIALS

Working with README.md on github.com

Leniel Macaferi
Feb 02, 2015
<p>There's a nice online/live editor here:</p> <p><a href="http://jbt.github.io/markdown-editor/" rel="nofollow">http://jbt.github.io/markdown-editor/</a></p> <p>There's also a <code>Preview</code> button at GitHub.</p> <p>See in the following screenshot that this button appears when I clicked Edit on <code>README.md</code>.</p> <p><img src="http://i.stack.imgur.com/OcBkm.png" alt="enter image description here"></p> <p>IMHO the live <a href="http://jbt.github.io/markdown-editor/" rel="nofollow">editor</a> is better than the current one available at GitHub.</p> <p><strong>UPDATE</strong></p> <p>Just now I found after searching for <code>Markdown</code> and Visual Studio that if you're using VS, you can install <a href="http://vswebessentials.com/" rel="nofollow">Web Essentials</a> and have <code>Markdown</code> support right from within Visual Studio. That's cool!</p> <p>It has:</p> <ul> <li>Syntax highlighting =&gt; Full colorization for Markdown syntax</li> <li>Intellisense for embedded languages (<strong><em>W00T</em></strong>) =&gt; GitHub's embedded language feature is fully support by support for the ```language syntax.</li> </ul> <p><img src="http://i.stack.imgur.com/xeyVv.png" alt="enter image description here"></p> <ul> <li>Preview window =&gt; See a side-by-side preview window of the rendered HTML</li> <li>Compile to HTML =&gt; Right-click any Markdown file and select Compile Markdown to HTML. This will generate a .html file nested under the Markdown file and it will stay in sync as the Markdown file changes.</li> <li>Custom Stylesheet =&gt; You can add a solution specific Stylesheet to control the styles of the preview window.</li> </ul> <p>Details about it <a href="http://vswebessentials.com/features/markdown" rel="nofollow">here</a>. </p> <p>This tip was originally posted on <a href="http://stackoverflow.com/questions/10240125/Working%20with%20README.md%20on%20github.com/23772049">Stack Overflow</a>.</p>
comments powered by Disqus