SwiftDocOrg / Swiftmarkup
Licence: mit
Parses Swift documentation comments into structured entities
Stars: β 55
Programming Languages
swift
15916 projects
Labels
Projects that are alternatives of or similar to Swiftmarkup
Tui.editor
ππ Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.
Stars: β 14,016 (+25383.64%)
Mutual labels: documentation, commonmark
Editor.md
The open source embeddable online markdown editor (component).
Stars: β 11,741 (+21247.27%)
Mutual labels: documentation, commonmark
Symbian Archive
A small website to archive Symbian-related dev tools & doc.
Stars: β 46 (-16.36%)
Mutual labels: documentation
Parse Comments
Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.
Stars: β 53 (-3.64%)
Mutual labels: documentation
Docs
The API for generating high quality images from HTML/CSS.
Stars: β 49 (-10.91%)
Mutual labels: documentation
Documentation
Official documentation of the Themosis framework.
Stars: β 51 (-7.27%)
Mutual labels: documentation
Arg.js
π¦π· π NPM library. Validation of Argentinian bank account numbers, IDs and phone numbers
Stars: β 52 (-5.45%)
Mutual labels: documentation
Jsdoc Baseline
An experimental, extensible template for JSDoc.
Stars: β 51 (-7.27%)
Mutual labels: documentation
Covenant Generator
`covgen` generates a code of conduct.
Stars: β 48 (-12.73%)
Mutual labels: documentation
42docs
Documentation on MiniLibX and 2019 curriculum projects
Stars: β 51 (-7.27%)
Mutual labels: documentation
Autoobjectdocumentation
Auto Object Documentation - JavaScript
Stars: β 54 (-1.82%)
Mutual labels: documentation
SwiftMarkup
SwiftMarkup parses Swift Markup from documentation comments into structured documentation entities.
import SwiftMarkup
let markdown = #"""
Creates a new bicycle with the provided parts and specifications.
- Remark: Satisfaction guaranteed!
The word *bicycle* first appeared in English print in 1868
to describe "Bysicles and trysicles" on the
"Champs ElysΓ©es and Bois de Boulogne".
- Parameters:
- style: The style of the bicycle
- gearing: The gearing of the bicycle
- handlebar: The handlebar of the bicycle
- frameSize: The frame size of the bicycle, in centimeters
- Returns: A beautiful, brand-new bicycle,
custom-built just for you.
"""#
let documentation = try Documentation.parse(markdown)
documentation.summary?.description // "Creates a new bicycle with the provided parts and specifications."
documentation.discussionParts.count // 2
if case .callout(let remark) = documentation.discussionParts[0] {
_ = remark.content // "Satisfaction guaranteed\\!"
}
if case .paragraph(let paragraph) = documentation.discussionParts[1] {
_ = paragraph.description // "The word *bicycle* first appeared in English print in 1868 [ ... ]"
}
documentation.parameters[0].name // "style"
documentation.parameters[0]?.content.description // "The style of the bicycle"
documentation.returns?.description // A beautiful, brand-new bicycle, custom-built just for you.
This package is used by swift-doc in coordination with CommonMark and SwiftSemantics to generate documentation for Swift projects.
Requirements
- Swift 5.2+
Installation
Swift Package Manager
Add the SwiftMarkup package to your target dependencies in Package.swift
:
import PackageDescription
let package = Package(
name: "YourProject",
dependencies: [
.package(
url: "https://github.com/SwiftDocOrg/SwiftMarkup",
from: "0.3.0"
),
]
)
Then run the swift build
command to build your project.
License
MIT
Contact
Mattt (@mattt)
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].