Skip to content

edinburghhacklab/announce-gen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hacklab-announce-gen

small tool to turn an announcement of some kind (written in markdown) into a print-friendly HTML document, which can also be copy-pasted into an email client, and spit out a message for sending in discord.

usage

install the dependencies, either by using the nix shell or reading shell.nix and finding them elsewhere.

put your report in site/index.md. this will not be committed to git.

run just build, or just dev if you want to get a live-reloading view. go to localhost:8000 in your browser.

then,

  • for email: hit ctrl+a and copy-paste into your email client. this should preserve the bits of formatting we care about
  • for print: print from your browser. if you need to preview it, you can print to pdf. disable headers and footers and such
  • for discord: copy build/<test.md>

media-specific tags

you can make sections be filtered out for certain media outputs by wrapping them in the following HTML elements:

  • <only-print> / <not-print>
  • <only-email> / <not-email>
  • <only-discord> / <not-discord>

qr code gen

if you wrap some text in <qr-code></qr-code> it will become a QR code.

this is most useful when combined with <only-print> and the grid system in site/css/base.css

About

a tiny tool for taking some announcement, and formatting it for print, email, and discord

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors