md2web

README

md2web

md2web converts a folder hierarchy of markdown files into a navigable website.

The functionality is provided in several forms:

• Runnable: The command run_md2web starts an md2web server in the working directory.
• Server: Server can be run from other programs when desired.
• Applications: Applications can be attached to other trim servers to provide the same functionality in a modular way.

Documentation:

Documentation is located at https://godoc.org/github.com/jwowillo/md2web.

Install

Change directory to run_md2web and type make. The template home page will be copied into the user's home directory.

Import

Import with import "github.com/jwowillo/md2web". Make sure the previous installation instructions were run. Then run go get.

Run

The command run_md2web <domain> <port:int> can be used to start the server.

Documentation

Overview

Package md2web contains the MD2Web trim.Application.

Index

• Constants
• type MD2Web
  • func New(h, bf string, excs []string) *MD2Web
  • func NewDebug(h, bf string, excs []string) *MD2Web

Constants

const Template = `` /* 1945-byte string literal not displayed */

Template file shown as page.

Types

type MD2Web

type MD2Web struct {
	*application.Web
}

MD2Web is a trim.Applications which turns directories of markdown files and folders into a website.

func New

func New(h, bf string, excs []string) *MD2Web

New creates a MD2Web excluding the provided files which has the given URL.

func NewDebug

func NewDebug(h, bf string, excs []string) *MD2Web

NewDebug creates an MD2Web that doesn't cache which has the given URL.