CODEWITHSUNDEEP
swiftxcode
swiftPunk
swiftPunk

Reputation: 1

How can I have a rendered markdown file in Xcode

Some times I need the document the important decisions in choosing approach or documenting current issue or bugges of framework or app or even future updates to code or new goals! This all things are just private and just for developer, I was using *.txt file for that then I update it to *.md file. But using *.md file is not all what I wanted, for example for having big title we should use # before title, but the sign of # is visible when I want read it and it is kind of annoying. Like this:

enter image description here

I have to say i am not looking to make documentation for functions or structs or other things. I just want type some text about app itself. How can i remove # from *.md file in render mode when I need read it. I know there is an option about playground but I do not want use it. I think a *.md file is good for my use case if I could make it looks nicer, also I have no idea how can I add link or make text bold or add a pic to my *.md file. Again this *.md file is just for me and it is going no where like GitHub it would stay private inside project.

Upvotes: 6

Views: 11925

Answers (1)

Sherzod
Sherzod

Reputation: 96

Place the .xcodesamplecode.plist in your foo.xcworkspace directory if you have a workspace named foo. If you are just working with a project, place it in your foo.xcodeproj dir.

The content should be:

<?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>

But there are some nuances: After that, editing .md files will not be very convenient.

To edit the contents of the .md file:

  1. Open your .md file
  2. Go to right navigation pane and select "Show the File inspector"
  3. Change "Type" to the another type. For example: "Objective-C Source"
  4. Close your markdown file
  5. Select your file from the navigation pane and open as "Quick Look"

To view/render the contents of the .md file:

  1. Open your .md file
  2. Go to right navigation pane and select "Show the File inspector"
  3. Change "Type" to the "Markdown text"
  4. Close your markdown file
  5. Select your file from the navigation pane and open as "Quick Look"

Example

This is of course not very convenient. Instead, I recommend you install some kind of Markdown Editor

Upvotes: 8

Related Questions