zine
Zine - a simple and opinionated tool to build your own magazine.
- Mobile-first.
- Intuitive and elegant magazine design.
- Best reading experiences.
- Theme customizable, extend friendly.
- RSS Feed supported.
- Open Graph Protocol supported.
- Build into a static website, hosting anywhere.
Installation
cargo install zine
Get Started
Run zine new your-zine-site, you'll get following directory:
$ tree your-zine-site
your-zine-site
├── content # The content directory your issues located
│ └── issue-1 # The first issue directory
│ ├── 1-first.md # The first markdown article in this issue
│ └── zine.toml # The issue Zine config file
└── zine.toml # The root Zine config file of this project
2 directories, 3 files
Run zine serve to preview your zine site on your local computer:
$ cd your-zine-site
$ zine serve
███████╗██╗███╗ ██╗███████╗
╚══███╔╝██║████╗ ██║██╔════╝
███╔╝ ██║██╔██╗ ██║█████╗
███╔╝ ██║██║╚██╗██║██╔══╝
███████╗██║██║ ╚████║███████╗
╚══════╝╚═╝╚═╝ ╚═══╝╚══════╝
listening on http://127.0.0.1:3000
Run zine build to build your zine site into a static website:
$ cd your-zine-site
$ zine build
Build success! The build directory is `build`.
Dive into deep
A Zine project mainly consists of two kind zine.toml files and a bunch of markdown files.
Root zine.toml
This root zine.toml file describes your site meta and all your issue's info.
[site]
url = "https://your-domain.com"
name = "Your Zine Site Name"
description = ""
logo = "path/to/favicon"
# the locale to localize your Zine site. default to "en".
# Zine has builtin supported locales, please check the `locales` directory of this repo.
locale = "en"
# the menu tabs
menu = [
{ name = "About", url = "/about" },
{ name = "Blog", url = "/blog" },
]
# Declare authors of this magazine.
[authors]
# set editor to true will show the Editor badge on the author profile page
zine-team = { name = "Zine Team", editor = true, bio = "The Zine Team." }
# You can customize some theme elements in this section.
# All of those elements are optional.
[theme]
# the primary color
primary-color = "#abcdef"
secondary-color = "#fff"
# the main text color
main-color = "#000"
# the link color in article content
link-color = "#e07312"
# the background image
background-image = "/static/background.png"
# you can customize your footer here
footer-template = "templates/footer.html"
# Issue 1
[[issue]]
# the slug of this issue: https://your-domain.com/s1
slug = "s1"
# the number of this issue
number = 1
# issue title
title = "Issue 1"
# the directory path to parse this issue, you should put
# your markdown files in this directory
path = "content/issue-1"
# the introduction of this issue. optional.
intro = "content/issue-1/intro.md"
# Issue 2
[[issue]]
slug = "s2"
number = 2
title = "Issue 2"
path = "content/issue-2"
Issue zine.toml
The issue zine.toml file list all your articles of this issue.
[[article]]
# the slug of this article. E.g: https://your-domain.com/s1/1
slug = "1"
# the markdown file path of this article
file = "1-first.md"
# the title of this article
title = "First article"
# the optional author id of this article.
author = "zine-team"
# the cover of this article
cover = ""
# the publish date of this article
pub_date = "2022-03-20"
# whether to publish this article or not
publish = true
# whether mark this article as a featured article.
# the featured articles will be shown on the home page
featured = true
# Another article
[[article]]
Advanced
Author
Zine will generate a dedicated profile page for each author declared in the root zine.toml table.
[authors]
# https://your-domain.com/@alice
alice = { name = "Alice", bio = "An engineer." }
# https://your-domain.com/@bob
bob = { name = "Bob", avatar = "/cool/avatar.png", bio = "An engineer." }
The path of an author page consists of
@and author id, for example above, the path are@aliceand@bob.If the author of an article hasn't declared in
[authors], no author page will be generated for that author.
Pages
Every markdown file located in pages will be rendered as a Page. Just intuitive like this:
$ tree pages
pages
├── about.md # will be rendered as https://your-domain.com/about
├── blog
│ └── first.md # will be rendered as https://your-domain.com/blog/first
├── blog.md # will be rendered as https://your-domain.com/blog
└── faq.md # will be rendered as https://your-domain.com/faq
1 directory, 4 files
Comment
You can add an arbitrary number of comments for an article. Simply put the end matter below the article content.
end matter is a terminology similar to front matter in other Static Site Generators. Just like the front matter shown ahead of the markdown content, the end matter is shown below.
You cool article content.
+++
[[comment]]
author = "Bob"
bio = "A developer"
content = "The cool comment"
[[comment]]
author = "Alice"
bio = ""
content = "Another cool comment"
+++
Code blocks
Zine provides some advanced code blocks to help you write articles.
Author
The author code is designed to render the avatar-name link on the markdown page.
The syntax is very simple, just write like this @author_id. If the author_id is declared in the [authors] table of the root zine.toml, it will render the UI as expected, otherwise it fallback into the raw code UI.
URL preview
```urlpreview
https://github.com/zineland/zine
```
Some cool magazines powered by Zine
TODO
-
Support RSS Feed
-
Support render OGP meta
-
Support l10n
-
Support sitemap.xml
-
Support table of content
-
Support code syntax highlight
-
Support i18n
-
Generate word cloud for issue
License
This project is licensed under the Apache-2.0 license.
![[build] : Linking Error on apple silicon chip](https://avatars.githubusercontent.com/u/32222578?v=4)
1 Dec 27, 2021
2 Mar 20, 2022
3 Dec 17, 2023
42 Nov 8, 2022
801 Dec 28, 2022
74 Jul 9, 2023
15 Jun 7, 2024
14 May 30, 2023
5 Apr 2, 2024
4 Nov 23, 2023
1.2k Jan 1, 2023
3 Oct 24, 2023
177 Jan 5, 2023
55 Oct 6, 2022
14 Jul 23, 2022
25 Dec 20, 2022
359 Dec 26, 2022
43 May 15, 2022
3 Aug 19, 2022
15 Sep 11, 2022