Skip to content
This repository was archived by the owner on Oct 17, 2022. It is now read-only.

johnfairh/TMLXMLToMarkdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This framework provides an API for converting an XML document created by SourceKit that describes the documentation comment of a Swift declaration to markdown that is correctly parsed by redcarpet.

It seemed like a good idea at the time in order to improve Jazzy -- but then I learnt about Objective C and how irretreivably incompatible its doc comments are.

Maybe it will be useful one day!

Usage

import TMLXMLToMarkdown let markdown = XMLDeclaration.build(from: xml)

Installation

Swift package manager:

.Package(url: "https://github.com/johnfairh/TMLXMLToMarkdown", majorVersion: 1) 

License

Distributed under the MIT license.

About

Converting sourcekit xml to redcarpet markdown

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages