sahara-ooga/HaveXcode9RenderMarkdown.md

Created November 26, 2017 09:18

Star (5) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/sahara-ooga/8449aad0d7ef1bdfc22b3f9922c113fc.js"></script>
Save sahara-ooga/8449aad0d7ef1bdfc22b3f9922c113fc to your computer and use it in GitHub Desktop.

Download ZIP

Have Xcode 9 render markdown

Raw

HaveXcode9RenderMarkdown.md

Have Xcode 9 render markdown

To make Xcode 9 render markdown file eg. README.md, drop .xcodesamplecode.plist in your .xcodeproj/ folder. .xcodesamplecode.plist is like this:

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> <plist version="1.0"> <array/> </plist>

For convenience, There is this tool, which is derived from a tutorial.

brew install corekit/brew/renderer
cd /your/xcode/project/path
renderer

Note that while xcode 9 render option is on, you can`t edit the markdown file in Xcode 9.

deden commented Mar 27, 2019

The easiest way to render markdown in Xcode is by using QuickLook.

Install qlmarkdown plugin https://github.com/toland/qlmarkdown
README.md > Open as > Quick look

Peter-Schorn commented Jun 4, 2020

This worked for me when adding the .xcodesamplecode.plist to my .xcodeproj/ folder. However, it didn't work when I tried to add the file to a package I created. Does anyone have any ideas?