Skip to content

mathieubellon/hugy

Repository files navigation

Hugy


icon-128x128-2x

The dead simple Hugo companion.

Hugy is an Electron desktop app acting as a GUI for the Hugo static site generator.

Designed for copywriters onboarding Hugo projects without command line knowledge needed.

🚨 Warning - not production ready - pre-alpha stage

This is a proof of concept at the moment, almost pre-alpha. Test it but only on versioned Hugo projects.

Table of Contents

Introduction

Hugy is a desktop (Electron) app aimed at content editors onboarding projects using the Hugo static site generator. Static sites are great and Hugo is a great static site generator, but due to its technical nature (a command line tool) it may be hard to ask copywriters to use it in projects.

Hugy assumes that your workflow is git-centered as it will allow the content editor to push changes to a git repo.

Roadmap

V1.0

  • Download available for Mac and Windows
  • Create or clone Hugo project
  • Navigate content folder, add, edit content with a nice WYSIWYG tool
  • Manage project configuration (config.toml)
  • Live preview your website as you edit content
  • Manage multiples local versions of your website. Rollback changes.
  • Publish (push) your changes

V1.x

  • Create new content based on archetypes
  • Manage taxonomies
  • Manage menus
  • Configure Hugy with a versioned config file
  • Embedded documentation (Both for Hugy and Hugo)

Screenshots

Live edit

live_edit

Manage Hugo

console

Instant real preview

live_edit

Feedback

Use GitHub issues. We probably will create a discourse/Gitter space in the near future.

Development

Clone the repo and ..

Project setup

yarn install

Compiles and hot-reloads for development

yarn electron:serve

Compiles and minifies for production

Not working yet

About

Hugy is an Electron desktop app acting as a GUI for the Hugo static site generator.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published