goslides

command module
v0.0.0-...-2d699da Latest Latest
Warning

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

Go to latest
Published: Nov 15, 2023 License: MIT Imports: 19 Imported by: 0

README

goslides

a tool to write and display slides in Go's way

Documentation

Overview

Present displays slide presentations and articles. It runs a web server that presents slide and article files from the current directory.

It may be run as a stand-alone command or an App Engine app.

To use with App Engine, copy the files in the tools/cmd/present directory to the root of your application and create an app.yaml file similar to this:

runtime: go111

handlers:
- url: /favicon.ico
  static_files: static/favicon.ico
  upload: static/favicon.ico
- url: /static
  static_dir: static
- url: /.*
  script: auto

# nobuild_files is a regexp that identifies which files to not build.  It
# is useful for embedding static assets like code snippets and preventing
# them from producing build errors for your project.
nobuild_files: [path regexp for talk materials]

When running on App Engine, content will be served from the ./content/ subdirectory.

Present then can be tested in a local App Engine environment with

GAE_ENV=standard go run .

And deployed using

gcloud app deploy

Input files are named foo.extension, where "extension" defines the format of the generated output. The supported formats are:

.slide        // HTML5 slide presentation
.article      // article format, such as a blog post

The present file format is documented by the present package: https://pkg.go.dev/golang.org/x/tools/present

Directories

Path Synopsis
content
tools
present
Package present implements parsing and rendering of present files, which can be slide presentations as in golang.org/x/tools/cmd/present or articles as in golang.org/x/blog (the Go blog).
Package present implements parsing and rendering of present files, which can be slide presentations as in golang.org/x/tools/cmd/present or articles as in golang.org/x/blog (the Go blog).

Jump to

Keyboard shortcuts

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