https://github.com/rudeigerc/yggdrasill
A minimal theme for Hugo
https://github.com/rudeigerc/yggdrasill
giscus hugo hugo-theme
Last synced: 9 months ago
JSON representation
A minimal theme for Hugo
- Host: GitHub
- URL: https://github.com/rudeigerc/yggdrasill
- Owner: rudeigerc
- License: mit
- Created: 2020-08-01T14:10:58.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T08:56:43.000Z (almost 2 years ago)
- Last Synced: 2024-09-09T10:43:37.258Z (almost 2 years ago)
- Topics: giscus, hugo, hugo-theme
- Language: SCSS
- Homepage: https://yggdrasill.rudeigerc.dev
- Size: 245 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yggdrasill
A minimal theme for [Hugo](https://gohugo.io/).
> **⚠︎ Work in Progress ⚠︎**
>
> Please visit https://yggdrasill.rudeigerc.dev for the latest demo of the theme. The theme is under development and the styles may not remain the same.
The design is partially inspired by:
- [vividvilla/ezhil](https://github.com/vividvilla/ezhil)
- [MUI: The React component library you always wanted](https://mui.com/)
- [Diu.notes](https://notes.ljl.li/)
## Installation
### Install with Hugo Modules
```shell
# Initialize the Hugo module system
$ hugo mod init github.com//
```
In `config.toml`:
```toml
theme = "github.com/rudeigerc/yggdrasill"
# Import the theme
[module]
[[module.imports]]
path = "github.com/rudeigerc/yggdrasill"
```
Please refer to the [Hugo documentation](https://gohugo.io/hugo-modules/use-modules/) for more information about installation with Hugo modules.
### Install with Git Submodules
```shell
$ git submodule add https://github.com/rudeigerc/yggdrasill themes/yggdrasill
```
In `config.toml`:
```toml
theme = "yggdrasill"
```
## Update
### Update with Hugo Modules
```shell
$ hugo mod get -u github.com/rudeigerc/yggdrasill
```
### Update with Git Submodules
```shell
$ git submodule update --remote
```
## Development
Yggdrasill uses [pnpm](https://pnpm.io/) as the package manager for development, mostly for linting and formatting.
```shell
$ pnpm install
```
## License
Yggdrasill is licensed under the MIT License.