present2html

command module
v0.0.0-...-6709330 Latest Latest
Warning

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

Go to latest
Published: Jul 8, 2024 License: MIT Imports: 6 Imported by: 0

README

present2html

Convert a presentation from go present format to a statically servable HTML page.

A community day project for GopherCon 2024.

Installation

go install github.com/packrat386/present2html@latest

Usage

The binary takes a single argument which is the presentation to convert, and writes the HTML to standard output.

present2html presentation.slide > presentation.html

The resulting HTML has the JavaScript and CSS embedded directly into it (as opposed to referenced as a <link>).

Files that are referenced within command invocations (e.g. .code some_file.go) will be read relative to the input file.

Feature Support

This currently supports rendering .slide presentations to a single HTML page with all the relevant inline markdown. Support for the command invocations is limited. I have tested both .code and .link and can confirm they work. I have tested .image and confirm is does not (TODO: I want to load the image as base64 right into the rendered page). I have not tested any of the other command invocations.

This library does not support playground features or presenter notes and I have no real plans to add support for them.

I have only tested this with the "new" markdown format and not the legacy present format. I have no reason to suspect it wouldn't work though.

License

This work is licensed under the terms found in LICENSE.txt (MIT License).

Large portions of this have been adapted from code found in golang.org/x/tools. Per the conditions of their license, the original terms are included in GOLANG_X_TOOLS_LICENSE.txt, and I have added comments to the files that were adapted directly.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL