Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/realmq/realmq-website
RealMQ offical web page.
https://github.com/realmq/realmq-website
hugo netlify website
Last synced: about 1 month ago
JSON representation
RealMQ offical web page.
- Host: GitHub
- URL: https://github.com/realmq/realmq-website
- Owner: realmq
- Created: 2018-04-25T14:33:15.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2023-08-01T11:03:13.000Z (over 1 year ago)
- Last Synced: 2024-11-14T08:41:49.456Z (3 months ago)
- Topics: hugo, netlify, website
- Language: SCSS
- Homepage: https://realmq.com
- Size: 4.82 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# realmq website
A static site build with hugo, gulp and deployed via netlify to https://realmq.com.
The theme is based on [TheSaas][TheSaas].
## Getting started
In order to hack realmq website locally you need to have hugo static site generator installed.
```bash
# Linux
$ snap install hugo
# macOS
$ brew install hugo
```
If you are not covered read this [installation guide][Hugo Installation Guide].
Next, install the asset build tools:
```bash
$ npm i
```
Then build the project:
```bash
$ npm run build
```
Finally run the dev pipeline with live reload upon file change.
```bash
$ npm run dev
```
## Directory Structure
```
|- content # gonnabe website content/pages
|- data # .yml, .json and .toml data files
|- layouts # html templates
|-- 404.html # 404 error page
|-- index.html # Home page
|- public # deploy directory of generated pages and assets
|- src # asset source directory (scss, img)
|-- img # images
|-- scss # entrypoint and theme adjustments
|-- thesaas # base theme scss sources
|- static # build directory (css, img)
|- config.toml # hugo config file
|- gulpfile.js # asset build pipeline
```
For more information on hugo's directories: [read this article][Hugo Directory Structure]
## Asset build pipeline
* **COMPILE**: The scss files from `src/scss/*` will be compiled into css to `static/css`
* **COPY**: The images from `src/img` will be copies to `static/img`
* **REV**: All generated assets will be [revisioned](Gulp Rev) by appending content hash to their file names.
* **REV**: Revisioned css files will be rewritten to resolve the revisioned assets.
* **REV**: A manifest containing a map of all revisioned assets will be generated to `data/assets.json`
Within templates you have to reference assets via their rev mapping:
```html
```
There is also a short code:
```html
}}">
```
## Helpful Resources
* [Hugo Page][Hugo]
[Gulp Rev]: https://www.npmjs.com/package/gulp-rev
[Hugo]: https://gohugo.io
[Hugo Directory Structure]: https://gohugo.io/getting-started/directory-structure/
[Hugo Installation Guide]: https://gohugo.io/getting-started/installing/
[TheSaas]: https://gitlab.com/realmq/thesaas-theme