Hugiki is a WYSIWYW (what you see, is what you want) editing frontend for creating Hugo-based websites. Using Hugiki helps to reduce page-editing turnaround time as all the editing and preview happens in the same browser. When building Hugo-based webpages it provide an integrated "look and feel" experience compared to the ordinary manual approach, so Hugo beginners also better can relate to website building process.
Hugo is a fast building system for fast static websites, so Hugo transforms markdown-text content, other content and templates into a complete static website.
See more about Hugo
Hugo, as a static markdown-text based website builder, might not be complete userfriendly solution for many users, as the website construction process for them
- requires knowledge of markdown language and has a steeper learning curve than just "clicking" in a graphical user interface
- assumes the user has a good imagination and experience of how the markdown-text will look like in the final website ie. no direct "look and feel"
- leads to many interations of editing & saving the markdown-text documents and reloading the generated webpage in a separate webbrowser
All these issues are otften resolved in other (dynamic) website building solutions such as CMS (content management systems) addressed by a WYSIWYG-approach (what you see, is what you get). Unfortunately these CMS' are known to have deficiencies in other areas such as the final website's stability, security and performance.
Hugiki brings the element of faster reaction to changes of a Hugo website by allowing the user to edit the markdown-text, show the resulting Hugo-generated webpage within the same browser-view of a Hugiki-webpage and react to changes in it.
The word Hugiki derives from
- Hugo - the static website builder
- Wiki - the Hawaiian word for quick (see Wikipedia)
Hugiki is currently in a explorative development / prototype phase, so many thing might change drastically between version uploads
Here is a list of features and their state that are currently technical viable to be implemented in a shorter term
- Editing content markdown-files and fast review of result (state: testing)
- Hugiki application menu (state: testing)
- Hugo project files exploration (state: testing)
- Formating of Hugigki output via CSS "cascaded style sheets" (state:todo next)
- Online configuration settings (state: idea)
- Basic git integration for managing (state: idea)
- Editing other files than the Hugo content-markdown files (state: idea)
- Autostart of Hugo-webserver as a sub-process (state: idea)
go install github.com/sascha-dibbern/Hugiki@latest
git clone git@github.com:sascha-dibbern/Hugiki.git
cd Hugiki
go build
Create a configuration file myproject.yml in Yaml format for a Hugo project under /home/user/projects/demosite:
backendbaseurl: http://localhost:1313/
hugoproject: /home/user/projects/demosite
- backendbaseurl: the link url to separate started Hugo webserver
- hugoproject: the filesystem path to Hugo project to be edited. In Window slash-based path (
C:/projects/demosite1) are allowed
For a working Hugiki-setup a Hugo development server has to be started for automtic website-rendering. Hugiki will proxy the markdown and rendered content from Hugo-server and the Hugo-project files in the local filesystem.
First start Hugo's development server to view the enable site.
cd /home/user/projects/demosite
hugo server
or for enabling viewing and editing draft documents
cd /home/user/projects/demosite
hugo server -D
(See also more at Hugo quick start)
Hugo's development server will provide content on your computer under http://localhost:1313/ that Hugiki will proxy through to the Hugiki session.
Next start Hugiki
Hugiki --config myproject.yml
Hugiki will provide a webserver under http://localhost:3000/ From here one can browse and edit the content of the Hugo project and preview the autogenerated pages too.