Git Product home page Git Product logo

markdown.owin's Introduction

Markdown.Owin

A simple piece of OWIN middleware to serve up markdown files.

Disclaimer

Note that this is still very much a work in progress. It is a first attempt at writing a markdown server that supports Razor templates.

If you are interested in the idea please chime in.

Motivation

My intended use-case is to make it easy to incorporate documentation for CURIE links to point to inside a hypermedia driven API.

Initial requirements

  • Serve markdown files as html (use: https://github.com/Knagis/CommonMark.NET)
  • Allow for templating based on Razor views (use: https://github.com/Antaris/RazorEngine)
  • Have 404 handling logic, so requests can fall through
  • Use conventions to determine:
    • Request path
    • Template to use
  • Allow for a way to generate basic navigation inside the Razor template
    • siblings
    • home
    • 1st level
  • Work in both IIS and console app ... basically any OWIN host

Intended usage

using Owin;

namespace Markdown.Owin.Demo
{
	public class Startup
	{
		public void Configuration(IAppBuilder builder)
		{
			builder.Use(typeof(MarkdownOwinMiddleware), new MarkdownOwinOptions
			{
				RootRequestPath = "/docs", // request path to serve within
				RootDirectory = "Markdown", // folder where the resources (md and cshtml files) reside
				Http404Behavior = Http404Behavior.FallThrough // must be play nice with WebApi or f.ex. Nancy
			});
		}
	}
}

markdown.owin's People

Contributors

wis3guy avatar

Stargazers

 avatar Mogens Heller Grabe avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.