Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/en9inerd/zola-hacker
Hacker is a Zola theme
https://github.com/en9inerd/zola-hacker
zola zola-theme
Last synced: about 1 month ago
JSON representation
Hacker is a Zola theme
- Host: GitHub
- URL: https://github.com/en9inerd/zola-hacker
- Owner: en9inerd
- License: mit
- Created: 2024-07-21T14:38:06.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-08-07T14:33:41.000Z (5 months ago)
- Last Synced: 2024-08-08T17:00:55.996Z (5 months ago)
- Topics: zola, zola-theme
- Language: HTML
- Homepage: https://zola-hacker.enginerd.io
- Size: 365 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - en9inerd/zola-hacker - Hacker is a Zola theme (HTML)
README
# Hacker theme for Zola
Zola Hacker is a minimalistic theme for Zola, inspired by the [Hacker theme](https://pages-themes.github.io/hacker/) for Jekyll. It is designed for developers who want to write blogs.
## Demo
[Live Preview](https://zola-hacker.enginerd.io/).
## Requirements
Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.19.1.
## Quick Start
```bash
git clone [email protected]:en9inerd/zola-hacker.git
cd zola-hacker
zola serve
# open http://127.0.0.1:1111/ in the browser
```
## Installation
Just earlier we showed you how to run the theme directly. Now we start to
install the theme in an existing site step by step.
### Step 1: Create a new zola site
```bash
zola init mysite
```
### Step 2: Install Zola Hacker Theme
Download this theme to your themes directory:
```bash
cd mysite/themes
git clone [email protected]:en9inerd/zola-hacker.git
```
Or install as a submodule:
```bash
cd mysite
git init # if your project is a git repository already, ignore this command
git submodule add [email protected]:en9inerd/zola-hacker.git themes/hacker
```
### Step 3: Configuration
Enable the theme in your `config.toml` in the site directory:
```toml
theme = "hacker"
```
Or copy the `config.toml` from the theme directory to your project's
root directory:
```bash
cp themes/hacker/config.toml config.toml
```
### Step 4: Add new content
You can copy the content from the theme directory to your project:
```bash
cp -r themes/hacker/content .
```
You can modify or add new posts in the `content/posts`, `content/pages` or other
content directories as needed.
### Step 5: Run the project
Just run `zola serve` in the root path of the project:
```bash
zola serve
```
Command will start the Zola development web server accessible by default at
`http://127.0.0.1:1111`. Saved changes will live reload in the browser.
## Customisation
You can customize your configurations, templates and content for yourself. Look
at the `config.toml`, `theme.toml`, `content` files and templates files in this
repo for an idea.
### Global Configuration
There are some configuration options that you can customize in `config.toml`.
#### Configuration options before `extra` options
Set the tags taxonomy in the `config.toml`:
```toml
taxonomies = [
{ name = "tags" },
]
```
#### Configuration options under the `extra`
The following options should be under the `[extra]` in `config.toml`
- `language_code` - set HTML file language (default to `en-US`)
- `title_separator` - the separator to your site title, like `|` and `-` (defaults to `|`)
- `logo` - path to the logo image
- `google_analytics` - Google Analytics tracking ID
- `timeformat` - the timeformat for the blog article published date
- `timezone` - the timezone for the blog article published date
- `edit_page` - whether to show the edit page in the github repo for your posts
- `menu` - set the menu items for your site
- `contact_form_script_id` - the script id for the contact form based on [Google Script](https://github.com/en9inerd/learn-to-send-email-via-google-script-html-no-server)
- `[extra.github]` - set the GitHub metadata for your site
- `[extra.giscus]` - set the Giscus settings for your site to enable the comments
- `[extra.opengraph]` - set the Open Graph metadata for your site
- `[extra.pgp_key]` - set pgp key in the footer for certain pages
- `social_links` - set the social media links in the footer
...
### Templates
All pages are extend to the `base.html`, and you can customize them as need.
### Shortcodes
The theme provides some shortcodes to help you write your content:
`contact_form`
The `contact_form` shortcode is based on [Google Apps Mail](https://github.com/en9inerd/learn-to-send-email-via-google-script-html-no-server) to send emails without a server.
It depends on `contact_form_script_id` in the `config.toml`.
```markdown
{{ contact_form() }}
```
`cv`
The `cv` shortcode is used to display the CV in the page. Data for CV is stored in yaml format in the `data/cv` directory.
```markdown
{{ cv() }}
```
`github_avatar`
The `github_avatar` shortcode is used to display the GitHub avatar image. It depends on `extra.github.username` in the `config.toml`. Also, you can pass size as an argument.
```markdown
{{ github_avatar(size=100) }}
```
`projects`
The `projects` shortcode is used to display repositories from GitHub. It depends on `extra.github.username` in the `config.toml` and `extra.repo_names` in page front matter to filter the repositories.
```markdown
{{ projects() }}
```
## Reporting Issues
We use GitHub Issues as the official bug tracker for the **Zola Hacker Theme**. Please
search [existing issues](https://github.com/en9inerd/zola-hacker/issues). It’s
possible someone has already reported the same problem.
If your problem or idea is not addressed yet, [open a new issue](https://github.com/en9inerd/zola-hacker/issues/new).
## License
**Zola Hacker Theme** is distributed under the terms of the
[MIT license](https://github.com/en9inerd/zola-hacker/blob/master/LICENSE).