Skip to content

A website for the Fiveum project, a real-time collaboration tool for workers needing focus.

Notifications You must be signed in to change notification settings

vnayar/fiveum-site

Repository files navigation

Abstract

The purpose of this project is to build a website for the Fiveum project, an alternative to Slack that focuses on the needs of knowledge workers, namely, avoiding interruptions and keeping track of multiple tasks.

The project is built using Hugo, a static website building tool whose input is a Markdown-like syntax. The hosting is done on GitHub Pages.

Local Development

Generating Static Pages

To generate static HTML, simply invoke the following command:

$ hugo

The output will be placed into the directory /public.

Starting the Server

$ hugo server

Browse at http://localhost:1313/fiveum-site/

By default, drafts and features like Disqus are not included, to include these features, run the following command:

$ hugo --buildDrafts

Templates and Assets

Extracting assets: https://gohugo.io/hugo-pipes/introduction/#get-resource-with-resourcesget-and-resourcesgetremote

Function to execute a file as a template: https://gohugo.io/hugo-pipes/resource-from-template/

Deployment to GitHub Pages

Following Instructions here: https://gohugo.io/hosting-and-deployment/hosting-on-github/

The page will be updated every time a push is maded to the master branch. The GitHub workflow will run the hugo command and produce contents that go in the /public/ directory, there is no need to add these files to the source repository.

The generated page can be viewed at: https://vnayar.github.io/fiveum-site/

About

A website for the Fiveum project, a real-time collaboration tool for workers needing focus.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published