https://github.com/zineland/zine Skip to content Sign up * Product + Features + Mobile + Actions + Codespaces + Packages + Security + Code review + Issues + Integrations + GitHub Sponsors + Customer stories * Team * Enterprise * Explore + Explore GitHub + Learn and contribute + Topics + Collections + Trending + Learning Lab + Open source guides + Connect with others + The ReadME Project + Events + Community forum + GitHub Education + GitHub Stars program * Marketplace * Pricing + Plans + Compare plans + Contact Sales + Education [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} zineland / zine Public * Notifications * Fork 12 * Star 424 Zine - a simple and opinionated tool to build your own magazine. Apache-2.0 License 424 stars 12 forks Star Notifications * Code * Issues 3 * Pull requests 2 * Actions * Projects 0 * Wiki * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Wiki * Security * Insights This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 1 branch 6 tags Code Latest commit @Folyd Folyd Fix rewrite path condition check (#42) ... 8bb9f12 Apr 10, 2022 Fix rewrite path condition check (#42) 8bb9f12 Git stats * 164 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github/workflows Remove --locked Apr 5, 2022 demo Add author page (#36) Apr 9, 2022 locales Add author page (#36) Apr 9, 2022 src Fix rewrite path condition check (#42) Apr 10, 2022 static Fix url-preview a tag styles Apr 10, 2022 templates Add author page (#36) Apr 9, 2022 .gitignore Have a integration with clap Mar 4, 2022 Cargo.toml Release v0.3.1 Apr 6, 2022 LICENSE Initial commit Feb 25, 2022 README.md Support generate sitemap.xml (#29) Mar 31, 2022 tailwind.config.js Fix link color css variable name Mar 19, 2022 zine-entry.css Fix url-preview a tag styles Apr 10, 2022 zine.svg Add zine logo (#21) Mar 29, 2022 View code [ ] zine Installation Get Started Dive into deep Root zine.toml Season zine.toml Advanced Pages Comment Code blocks URL preview Some cool magazines powered by Zine TODO License README.md [zine] zine Crates.io Crates.io license-apache 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 seasons located | +-- season-1 # The first season directory | +-- 1-first.md # The first markdown article in this season | +-- zine.toml # The season 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 season'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" }, ] # 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" # Season 1 [[season]] # the slug of this season: https://your-domain.com/s1 slug = "s1" # the number of this season number = 1 # season title title = "Season 1" # the directory path to parse this season, you should put # your markdown files in this directory path = "content/season-1" # the introduction of this season. optional. intro = "content/season-1/intro.md" # Season 2 [[season]] slug = "s2" number = 2 title = "Season 2" path = "content/season-2" Season zine.toml The season zine.toml file list all your articles of this season. [[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 of this article author = "" # 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 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. URL preview ```urlpreview https://github.com/zineland/zine ``` Some cool magazines powered by Zine * https://2d2d.io 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 season License This project is licensed under the Apache-2.0 license. About Zine - a simple and opinionated tool to build your own magazine. Topics static-site-generator magazine zine ssg Resources Readme License Apache-2.0 License Stars 424 stars Watchers 9 watching Forks 12 forks Releases 2 Release v0.3.1 Latest Apr 6, 2022 + 1 release Packages 0 No packages published Contributors 3 * @Folyd Folyd Folyd * @KernelErr KernelErr Rui Li * @DingDean DingDean Ke Ding Languages * Rust 77.4% * Jinja 17.6% * JavaScript 4.0% * Other 1.0% * (c) 2022 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.