Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antonioalmeida/texugo-theme
🦡 Minimalistic website theme for Hugo based on Tex's typography.
https://github.com/antonioalmeida/texugo-theme
hacktoberfest hugo hugo-theme minimal tex
Last synced: about 18 hours ago
JSON representation
🦡 Minimalistic website theme for Hugo based on Tex's typography.
- Host: GitHub
- URL: https://github.com/antonioalmeida/texugo-theme
- Owner: antonioalmeida
- License: mit
- Created: 2020-11-29T20:14:16.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-22T00:26:17.000Z (over 2 years ago)
- Last Synced: 2024-05-21T07:12:14.669Z (6 months ago)
- Topics: hacktoberfest, hugo, hugo-theme, minimal, tex
- Language: JavaScript
- Homepage:
- Size: 3.21 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Tex(h)ugo 🦡
Minimalistic website theme for [Hugo](https://gohugo.io/) based on [Tex](https://en.wikipedia.org/wiki/TeX)'s typography. Live preview available [here](https://antonioalmeida.github.io)
| Home | Post |
:-------------------------:|:-------------------------:
 | 
## Getting Started
Clone this repository inside your Hugo project theme directory.
```shell
$ mkdir themes
$ cd themes
$ git clone https://github.com/antonioalmeida/texugo-theme.git
```
## Configuration
Take a look at the [/exampleSite](https://github.com/antonioalmeida/antonioalmeida.github.io) directory.
Copy the `config.toml` to the root directory of your website and overwrite the existing information as needed:
__[config.toml](https://github.com/antonioalmeida/texugo-theme/blob/master/exampleSite/config.toml)__:
```toml
baseurl = "https://example.com"
languageCode = "en"
title = "Texugo"
theme = "texugo-theme"
copyright = "© John Doe 2020"
[params]
nickname = "johndoe"
name = "John Doe"
bio = ["Human being", "Not an animal", "a third thing"]
[[params.social]]
name = "Github"
url = "https://example.com"
[[params.social]]
name = "Twitter"
url = "https://example.com"
[[params.social]]
name = "LinkedIn"
url = "https://example.com"
[markup]
[markup.highlight]
codeFences = true
guessSyntax = false
hl_Lines = ""
lineNoStart = 1
lineNos = false
lineNumbersInTable = true
noClasses = true
style = "github"
tabWidth = 4
```
## Development
```shell
# run local server (localhost:1313)
$ hugo server
# make production build (/public)
$ hugo --minified
```
## Deployment
- Check [this repository](https://github.com/antonioalmeida/antonioalmeida.github.io/blob/master/.github/workflows/gh-pages.yml) as an example on how to deploy via Github Actions.
## Inspired by
- [Tex](https://en.wikipedia.org/wiki/TeX)
- [WiTex](https://github.com/AndrewBelt/WiTeX)
- [Charaka](https://github.com/natarajmb/charaka-hugo-theme)
## Tweaking the theme
- Set up and activate as your website's theme
- Inside the theme directory install dependencies: `$ npm install`
- Make required changes to `style.scss` and run `$ npm run css-build && npm run css-watch` to live update your changes
## License
`tex-hugo-theme` is licensed under the [MIT License](LICENSE.md).
## Author
[António Almeida](https://github.com/antonioalmeida)