themu/README.md

100 lines
2.7 KiB
Markdown
Raw Normal View History

2023-07-30 21:46:09 +03:00
## Демонстрация
[Посмотреть демо](https://fruw.org)
2020-04-11 17:45:12 +03:00
2023-07-30 21:46:09 +03:00
## Установка
В директории веб-сайта Hugo клонируйте репозиторий:
2020-04-11 17:45:12 +03:00
```bash
2023-07-30 23:57:05 +03:00
git submodule add https://github.com/fruworg/themu themes/themu
2020-04-11 17:45:12 +03:00
```
2023-07-30 21:46:44 +03:00
Нужно отредактировать файл `config.toml`, добавив строку `theme="themu"`.
2023-07-30 21:46:09 +03:00
Дополнительную информацию можно найти в официальном [руководстве по установке](https://gohugo.io/installation/) Hugo.
2020-04-11 17:45:12 +03:00
2023-07-30 21:46:09 +03:00
## Создание статей
Необходимо создать новый файл с расширением `.md` в папке *content/posts*:
2020-04-11 17:45:12 +03:00
```yml
---
2023-07-30 21:46:09 +03:00
title: Заголовок статьи
description: Описание
date: 2006-01-01T01:08:00+05:00
draft: true/false (необязательно)
tags: [названия тегов] (необязательно)
2020-04-11 17:45:12 +03:00
---
```
2023-07-30 21:46:09 +03:00
## Настройки конфигурации
2023-07-30 21:46:09 +03:00
### Пользовательские CSS-стили
Пользовательские CSS-файлы можно добавить с помощью параметра конфигурации `customcss`.
2023-07-30 21:46:09 +03:00
Примечание: CSS-файлы следует размещать в папке `assets`, например, `assets/css/first.css`.
```toml
[params]
2023-08-23 14:42:29 +03:00
customcss = ["css/first.css", "css/second.css"]
```
2023-07-30 21:46:09 +03:00
## Настройки демонстрационного сайта
2020-05-04 22:14:33 +03:00
```toml
2023-07-30 21:46:09 +03:00
baseURL = "https://<имя>.github.io"
2020-05-04 22:14:33 +03:00
languageCode = "en-us"
2023-07-30 21:46:09 +03:00
title = "<имя>"
2023-07-26 19:22:55 +03:00
theme="themu"
2023-07-31 19:30:53 +03:00
2023-07-30 21:46:09 +03:00
# Подсветка кода
2020-05-04 22:14:33 +03:00
pygmentsstyle = "monokai"
pygmentscodefences = true
pygmentscodefencesguesssyntax = true
2023-07-30 21:46:09 +03:00
paginate=3 # статей на страницу
2020-05-04 22:14:33 +03:00
[params]
2023-08-23 14:42:29 +03:00
description = themu description
subtitlefile = true # описание из partials/subtitle.html
subtitle = "Минимальная и чистая [тема блога для Hugo](https://github.com/fruworg/themu)" # текстовое описание
og_image = "image.png"
favicon = "favicon.ico"
2020-05-04 22:14:33 +03:00
2023-07-30 21:46:09 +03:00
# Социальные ссылки
2020-05-04 22:14:33 +03:00
[[params.social]]
name = "GitHub"
icon = "github"
2023-07-30 21:46:09 +03:00
url = "https://github.com/<имя>"
2020-05-04 22:14:33 +03:00
[[params.social]]
name = "Twitter"
icon = "twitter"
2023-07-30 21:46:09 +03:00
url = "https://twitter.com/<имя>"
2020-05-04 22:14:33 +03:00
[[params.social]]
name = "GitLab"
icon = "gitlab"
2023-07-30 21:46:09 +03:00
url = "https://gitlab.com/<имя>"
2020-05-04 22:14:33 +03:00
2023-07-30 21:46:09 +03:00
# Пункты главного меню
2020-05-04 22:14:33 +03:00
[[menu.main]]
2023-07-30 21:46:09 +03:00
name = "Главная"
2020-05-04 22:14:33 +03:00
url = "/"
weight = 1
[[menu.main]]
2023-07-30 21:46:09 +03:00
name = "Все статьи"
2020-05-04 22:14:33 +03:00
url = "/posts"
weight = 2
[[menu.main]]
2023-07-30 21:46:09 +03:00
name = "О сайте"
2020-05-04 22:14:33 +03:00
url = "/about"
weight = 3
[[menu.main]]
2023-07-30 21:46:09 +03:00
name = "Теги"
2020-05-04 22:14:33 +03:00
url = "/tags"
weight = 4
```
2023-07-30 21:54:20 +03:00
## Спасибо
[athul](https://github.com/athul/archie) и [jse.li](https://blog.jse.li)