https://github.com/planetarium/snack.planetarium.dev

Planetarium Engineering Snack
https://github.com/planetarium/snack.planetarium.dev

engineering-blog

Last synced: about 15 hours ago
JSON representation

Planetarium Engineering Snack

• Host: GitHub
• URL: https://github.com/planetarium/snack.planetarium.dev
• Owner: planetarium
• Created: 2019-03-18T06:48:54.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-12T10:17:35.000Z (8 days ago)
• Last Synced: 2024-11-12T11:23:29.823Z (8 days ago)
• Topics: engineering-blog
• Language: HTML
• Homepage: https://snack.planetarium.dev/
• Size: 32.9 MB
• Stars: 9
• Watchers: 14
• Forks: 15
• Open Issues: 23
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Planetarium Engineering Snack

=============================

This repository contains the contents and the website settings of

Planetarium Engineering Snack, our engineering blog.  The whole website

is compiled into static web pages using [Hugo].

[Hugo]: https://gohugo.io/

Local setup

-----------

 1. Install [Hugo] 0.134.0

    (You can install it by `brew install hugo` on macOS or

    `choco install hugo-extended` on Windows.)

 2. Clone this Git repository.

 3. In the cloned repository directory, type the following command:

    ~~~~ bash

    hugo server -w -F

    ~~~~

    This watches all file changes so that automatically recompiles them and

    let the browser refresh.

Writing posts

-------------

The posts are placed under *content/posts/* directory.  Posts are organized

according to their published dates and each post is named a short slug with

the three-letter language code, e.g.:

> *content/posts/2019/03/start.kor.md*

To add a new post, type the following command:

~~~~ bash

hugo new posts/`date +%Y/%m`/your-post.eng.md

~~~~

A created draft file would contain the sample front matter too.

The `authors` field is a list of author IDs and you could find all

author IDs from *data/authors/* directory (a *.toml* suffix is not

a part of an author ID).  You probably could not find the author data

file for yourself.  You should create a new author data file by yourself.