medad

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 8, 2023 License: GPL-3.0 Imports: 1 Imported by: 0

README

Medad - Content publisher

Converts Markdown documents to HTML files and uploads them to the server.

Contents

Features

  • Creates HTML files using overridable templates
  • Multilingual
  • Filter target articles to be compiled. This reflects on table of contents automatically
  • Uploads over FTP

Installation

Go

If you're a Gopher and want to install Medad locally in your GOPATH:

go install -v github.com/pattack/medad/cmd/medad@latest

AUR (Arch User Repository)

If you're using Arch Linux install medad or medad-git package from AUR

yay -S medad

Usage

Medad is a cli application consists of subcommands. Run with --help switch go get started.

medad --help

License

This software is licensed under the GPL v3 License. © 2023 Janstun

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Compiler 

type Compiler interface {
	Compile(tpl *template.Template, destination string, sources ...string) error
}

type Settings 

type Settings struct {
	ArticlesGlob  string
	TemplatesGlob string
	DistDirectory string

	FtpHost         string
	FtpPort         string
	FtpUsername     string
	FtpPassword     string
	RemoteDirectory string
}

type Uploader 

type Uploader interface {
	Upload(destination, source string) error
}

Source Files

View all Source files

Directories

Path Synopsis
cmd
medad

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.