Skip to content

Library for creating markdown documents, simulating SwiftUI syntax using Swift Result Builders

License

Notifications You must be signed in to change notification settings

josemortizs/ReadmeBuilder

Repository files navigation

ReadmeBuilder - v0.1

ReadmeBuilder es un paquete de Swift que permite a los desarrolladores crear archivos Markdown utilizando una sintaxis que se asemeja a SwiftUI. Este proyecto está diseñado para facilitar la creación de dichos tipos de documentos a aquellos programadores que ya están familiarizados con SwiftUI, pero que no necesariamente conocen la sintaxis de Markdown. En construcción...

Algunos ejemplos de uso...

Bloque de código:

Code {
    """
        var body: some View {
            Text("Hola mundo!")
        }
    """
}
.language(.swift)
    var body: some View {
        Text("Hola mundo!")
    }

Citas en bloque:

Blockquote { "Esto es una cita en bloque..." }

Esto es una cita en bloque...

Texto plano:

La extensión de String para que implemente el protocolo MarkdownProtocol permite que podamos agregar textos directamente, usando la sintaxis de String multilínea estándar en el lenguaje Swift

import Foundation

extension String: MarkdownProtocol {
    
    public func generateMarkdown() -> String {
        self.appending("  \n")
    }
}

Texto con tachados:

Text("The world is flat. We now know that the world is round.")
    .strikethroughText("The world is flat.")

The world is flat. We now know that the world is round.

Listas ordenadas:

OrderedList {
    "First item"
    "Second item"
    "Third item"
    "Fourth item"
}
  1. First item
  2. Second item
  3. Third item
  4. Fourth item

Listas desordenadas:

UnorderedList {
    "First item"
    "Second item"
    "Third item"
    "Fourth item"
}
  • First item
  • Second item
  • Third item
  • Fourth item

Images

ImagePath(path: "../Assets/images/tux.png")
    .textAlt("Tux, the Linux mascot")

Tux, the Linux mascot

About

Library for creating markdown documents, simulating SwiftUI syntax using Swift Result Builders

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages