Kitura-Markdown

A Templating engine for Kitura that uses Markdown based templates.

Summary

Kitura-Markdown enables a Kitura based server to serve HTML content generated from templates of Markdown (.md) marked up text. In addition Kitura-Markdown can be be used to generate HTML from Markdown formatted text passed to provided helper functions.

Example

The following is an example of a server that serves Markdown formatted text from .md files under the views/docs directory of the server's repository, as in the following structure:

ServerRepository
├── Package.swift
├── Sources
│   └── Server
│       └── main.swift
└── views
    └── docs
        ├── index.md
        └── doc1.md

In the main.swift file, there would be the following code:

import Kitura
import KituraMarkdown

// Create a new router
let router = Router()

// Add KituraMarkdown as a TemplatingEngine
router.add(templateEngine: KituraMarkdown())

// Handle HTTP GET requests to /docs
router.get("/docs") { _, response, next in
    try response.render("/docs/index.md", context: [String:Any]())
    response.status(.OK)
    next()
}

// Handle HTTP GET requests to /docs/......
router.get("/docs/*") { request, response, next in
    if let path = request.parsedURL.path, path != "/docs/" {
        try response.render(path, context: [String:Any]())
        response.status(.OK)
    }
    next()
}

// Add an HTTP server and connect it to the router
Kitura.addHTTPServer(onPort: 8090, with: router)

// Start the Kitura runloop (this call never returns)
Kitura.run()

If you pointed your browser at http://hostname:8090/docs or http://hostname:8090/docs/dec1.md, you would see the contents of index.md or doc1.md, respectively, in HTML form.

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.