103 lines
2.2 KiB
Markdown
103 lines
2.2 KiB
Markdown
|
# Galaxy
|
||
|
|
Galaxy is a minimal and cleam theme for hugo with a markdown-ish ui forked straight from the [archie](https://github.com/athul/archie) theme.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
In your Hugo website directory, create a new folder named theme and clone the repo
|
||
|
|
```bash
|
||
|
|
$ mkdir themes
|
||
|
|
$ cd themes
|
||
|
|
$ git clone https://github.com/athul/archie.git
|
||
|
|
```
|
||
|
|
Edit the `config.toml` file with `theme="galaxy"`
|
||
|
|
For more information read the official [setup guide](https://gohugo.io/installation/) of Hugo.
|
||
|
|
|
||
|
|
If you encounter any issues with Google Analytics, update Hugo to v0.125.0 or
|
||
|
|
later and make sure your using the latest version of the theme.
|
||
|
|
|
||
|
|
## Writing Posts
|
||
|
|
Create a new `.md` file in the *content/posts* folder
|
||
|
|
```yml
|
||
|
|
---
|
||
|
|
title: Title of the post
|
||
|
|
description:
|
||
|
|
date:
|
||
|
|
tldr: (optional)
|
||
|
|
draft: true/false (optional)
|
||
|
|
tags: [tag names] (optional)
|
||
|
|
toc: true/false (optional)
|
||
|
|
---
|
||
|
|
```
|
||
|
|
----
|
||
|
|
|
||
|
|
## Config Options
|
||
|
|
|
||
|
|
## Config of the Demo Site
|
||
|
|
todo
|
||
|
|
|
||
|
|
```toml
|
||
|
|
baseURL = "https://athul.github.io/archie/"
|
||
|
|
languageCode = "en-us"
|
||
|
|
title = "Archie"
|
||
|
|
theme="archie"
|
||
|
|
copyright = "© Athul"
|
||
|
|
# Code Highlight
|
||
|
|
pygmentsstyle = "monokai"
|
||
|
|
pygmentscodefences = true
|
||
|
|
pygmentscodefencesguesssyntax = true
|
||
|
|
|
||
|
|
disqusShortname = "yourDisqusShortname"
|
||
|
|
|
||
|
|
paginate=3 # articles per page
|
||
|
|
|
||
|
|
[params]
|
||
|
|
mode="auto" # color-mode → light,dark,toggle or auto
|
||
|
|
useCDN=false # don't use CDNs for fonts and icons, instead serve them locally.
|
||
|
|
subtitle = "Minimal and Clean [blog theme for Hugo](https://github.com/athul/archie)"
|
||
|
|
mathjax = true # enable MathJax support
|
||
|
|
katex = true # enable KaTeX support
|
||
|
|
|
||
|
|
# Social Tags
|
||
|
|
|
||
|
|
[[params.social]]
|
||
|
|
name = "GitHub"
|
||
|
|
icon = "github"
|
||
|
|
url = "https://github.com/athul/archie"
|
||
|
|
|
||
|
|
[[params.social]]
|
||
|
|
name = "Twitter"
|
||
|
|
icon = "twitter"
|
||
|
|
url = "https://twitter.com/athulcajay/"
|
||
|
|
|
||
|
|
[[params.social]]
|
||
|
|
name = "GitLab"
|
||
|
|
icon = "gitlab"
|
||
|
|
url = "https://gitlab.com/athul/"
|
||
|
|
|
||
|
|
# Main menu Items
|
||
|
|
|
||
|
|
[[menu.main]]
|
||
|
|
name = "Home"
|
||
|
|
url = "/"
|
||
|
|
weight = 1
|
||
|
|
|
||
|
|
[[menu.main]]
|
||
|
|
name = "All posts"
|
||
|
|
url = "/posts"
|
||
|
|
weight = 2
|
||
|
|
|
||
|
|
[[menu.main]]
|
||
|
|
name = "About"
|
||
|
|
url = "/about"
|
||
|
|
weight = 3
|
||
|
|
|
||
|
|
[[menu.main]]
|
||
|
|
name = "Tags"
|
||
|
|
url = "/tags"
|
||
|
|
weight = 4
|
||
|
|
```
|
||
|
|
---
|
||
|
|
|
||
|
|
### Naming
|
||
|
|
I had no idea what to name this theme, so I just went with the music's name I was listening at the time.
|
||
|
|
[Galaxy by geoxor](https://www.youtube.com/watch?v=574JWkI_nuc)
|