website/

directory
v0.23.2 Latest Latest
Warning

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

Go to latest
Published: May 6, 2024 License: Apache-2.0

README

Service Weaver Website

Service Weaver website is a static site generated by running a generator program, from within the top-level weaver directory:

go run dev/docgen/docgen.go

And to preview the resulting structure:

(cd website/public && python3 -m http.server)

You can also run go run dev/docgen/docgen.go --watch to automatically rebuild the website whenever the source files change.

Directory structure

Name Description
. Editable document contents in .md and .html files
assets Supporting CSS, Javascript, images
generate Web site generator
public Generated website (DO NOT EDIT!)
templates Go templates that define generated document structure

Adding a Blog Post

To add a blog post:

  1. Write the blog as a markdown file in blog/.
  2. Update blog/index.html with a link to the blog.
  3. Update dev/docgen/docgen.go with the markdown file.

Directories

Path Synopsis
blog
deployers/multi
Package main implements a simple multiprocess deployer.
Package main implements a simple multiprocess deployer.
deployers/single
Package main implements a simple singleprocess deployer.
Package main implements a simple singleprocess deployer.

Jump to

Keyboard shortcuts

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