Documentation
¶
Overview ¶
Package mkslides implements uses Markdown and templates to generate a sequence of HTML5 pages that can be used for presentations.
@author R. S. Doiel, <rsdoiel@caltech.edu>
Copyright (c) 2016, Caltech All rights not granted herein are expressly reserved by Caltech.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Index ¶
Constants ¶
const ( // Version of mkslides package Version = "v0.0.7" // LicenseText contains license text for cli using this module LicenseText = `` /* 1530-byte string literal not displayed */ )
Variables ¶
var ( // DefaultTemplateSource source provides the default HTML template for mkslides package, you probably want to override this... DefaultTemplateSource = `` /* 1847-byte string literal not displayed */ )
Functions ¶
func MakeSlideFile ¶
MakeSlideFile this takes a template and slide and renders the results to a file.
Types ¶
type Slide ¶
type Slide struct { CurNo int PrevNo int NextNo int FirstNo int LastNo int FName string Title string Content string CSSPath string JSPath string }
Slide is the metadata about a slide to be generated.
func MarkdownToSlides ¶
MarkdownToSlides turns a markdown file into one or more Slide using the fname, title and cssPath provided