Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avelino/hugo-theme-sarah
Sarah theme for Hugo static site generator
https://github.com/avelino/hugo-theme-sarah
hugo-blog-theme hugo-sarah hugo-theme hugo-theme-sarah static-site-generator
Last synced: about 2 months ago
JSON representation
Sarah theme for Hugo static site generator
- Host: GitHub
- URL: https://github.com/avelino/hugo-theme-sarah
- Owner: avelino
- License: mit
- Created: 2018-04-05T09:44:12.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-07-11T00:17:38.000Z (over 1 year ago)
- Last Synced: 2024-10-12T09:19:51.381Z (2 months ago)
- Topics: hugo-blog-theme, hugo-sarah, hugo-theme, hugo-theme-sarah, static-site-generator
- Language: SCSS
- Size: 6.05 MB
- Stars: 51
- Watchers: 4
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - avelino/hugo-theme-sarah - Sarah theme for Hugo static site generator (others)
README
# hugo-theme-sarah
**Sarah** theme for [Hugo](https://gohugo.io/) static site generator.
> **Why Sarah?** It is a possible name when I have a child (girl)
## Installation
Inside the folder of your Hugo site run:
```bash
mkdir themes
cd themes
git clone https://github.com/avelino/hugo-theme-sarah.git
```
For more information read the official [setup guide](https://gohugo.io/getting-started/installing/) of Hugo.
## Contribute
Node version 10 `nvm use $(cat .node-version)`
### Build SCSS
```bash
npm i
gulp build
```
## config.toml
### Nodes
#### [params]
| key | description |
| --- | --- |
| author | Author name |
| keywords | Keywords list |
| description | Site description with up to 160 characters, used on the initial page for indexing in search engines (SEO) |
| avatar | Author picture |
| dateform | Date format ([read more](https://discourse.gohugo.io/t/date-time-format-in-config-toml/5268/2)) |
| lang | Language that the main content will be written |
| footertext | Text at the end of the page (All rights reserved) |
| googleAnalytics | Google Analytics ID |
| aboutFile | Set markdow file, show on homepage |
| about | Author text, show on homepage |
| microsoftClarity | Microsoft Clarity ID |
#### [params.social]
| key | description |
| ---------- | ------------ |
| linkedin | Account name |
| twitter | Account name |
| github | Account name |
| googleplus | Account name |
| facebook | Account name |
#### [[params.info]]
| key | description |
| ----- | ----------- |
| label | Label |
| value | Valeu |
| link | Hyperlink |
#### [[params.projects]]
If not set this config, layout read by `content/projects/.md`, ex:
| key | description |
| ---- | ------------------------------- |
| name | Project name |
| desc | Project description |
| img | Image path (starting `static/`) |
| link | Hyperlink |
### Example
Show example in [exampleSite](https://github.com/avelino/hugo-theme-sarah/blob/master/exampleSite/config.toml)
```toml
baseURL = "http://avelino.xxx/"
languageCode = "en-us"
title = "Avelino"
theme = "sarah"
[permalinks]
fixed = ":title/"
blog = ":slug"
[params]
author = "Avelino"
keywords = ["Golang (Gopher)", "Neural Network", "Artificial Intelligence"]
description = "I use open source to help people evolve, I take pleasure in seeing people evolve"
avatar = "img/black-250.png"
dateform = "Jan 2, 2006"
lang = "en"
footertext = "written by avelino"
googleAnalytics = "UA-3063031-15"
aboutFile = "about.md"
about = """
I’m a currently a Chief Technology Officer (and founder) at [Nuveo](https://nuveo.ai/) (**Artificial Intelligence** within reach) and mathematician formed at [IME-USP](https://www.ime.usp.br/).
Work day-to-day with **artificial intelligence, neural network and computer vision**. With the need to process large dataset its focus of research and development include **distributed systems, competition, Lisp, Golang and Python**.
"""
[params.social]
linkedin = "avelino0"
twitter = "avelino0"
github = "avelino"
[[params.info]]
label = "Address"
value = "Brazil, São Paulo, SP"
[[params.projects]]
name = "Vim Bootstrap"
desc = "A generator which provides a simple method of generating a .vimrc configuration for vim"
img = "img/vimbootstrap.png"
link = "https://vim-bootstrap.com/"
[[params.projects]]
name = "Awesome Go"
desc = "A curated list of awesome Go frameworks, libraries and software"
img = "img/awesomego.png"
link = "https://awesome-go.com/"
```
## shortcodes
| name | example |
| ------------------------------------------ | ------------------------------------------------------ |
| [Speaker Deck](https://speakerdeck.com/) | `{{< speakerdeck 9951aee0382e0132d1604297f98471b0 >}}` |
| [Slide Share](https://www.slideshare.net/) | `{{< slideshare 2DLd4OvBUeGT2M >}}` |
| [scribd](https://scribd.com) | `{{< scribd 439578708 >}}` |
| [Google Maps](https://maps.google.com/) | `{{< googlemaps 1vmr0dHs0fWQ0Q6w_va_G2BYbcCfFsprM >}}` |
| [GitHub Repo](https://github.com/) | `{{< github 'avelino/awesome-go' >}}` |
## Screenshots
### Home
### Projects
### Blog
#### Latest Posts
#### Blogpost
