diff --git a/docs/content/themes/DeepThought/index.md b/docs/content/themes/DeepThought/index.md index 2078bc78..3bef98af 100644 --- a/docs/content/themes/DeepThought/index.md +++ b/docs/content/themes/DeepThought/index.md @@ -3,11 +3,11 @@ title = "DeepThought" description = "A simple blog theme focused on writing powered by Bulma and Zola." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/RatanShreshtha/DeepThought.git" homepage = "https://github.com/RatanShreshtha/DeepThought" minimum_version = "0.9.0" diff --git a/docs/content/themes/Ergo/index.md b/docs/content/themes/Ergo/index.md index 3a40d8cb..e32b9bdf 100644 --- a/docs/content/themes/Ergo/index.md +++ b/docs/content/themes/Ergo/index.md @@ -3,11 +3,11 @@ title = "Ergo" description = "A simple blog Theme focused on writing, inspired by svbtle" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/InsidiousMind/Ergo.git" homepage = "https://github.com/insipx/Ergo" minimum_version = "0.4.1" diff --git a/docs/content/themes/Zulma/index.md b/docs/content/themes/Zulma/index.md index e1a733c3..0c5d4ddd 100644 --- a/docs/content/themes/Zulma/index.md +++ b/docs/content/themes/Zulma/index.md @@ -3,11 +3,11 @@ title = "Zulma" description = "A zola theme based off bulma.css" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/Worble/Zulma" homepage = "https://github.com/Worble/Zulma" minimum_version = "0.6.0" diff --git a/docs/content/themes/_index.md b/docs/content/themes/_index.md index 28fdf9f1..5aa2e7b5 100644 --- a/docs/content/themes/_index.md +++ b/docs/content/themes/_index.md @@ -2,6 +2,5 @@ +++ template = "themes.html" sort_by = "date" -in_search_index = false +++ \ No newline at end of file diff --git a/docs/content/themes/adidoks/index.md b/docs/content/themes/adidoks/index.md new file mode 100644 index 00000000..065ef76d --- /dev/null +++ b/docs/content/themes/adidoks/index.md @@ -0,0 +1,197 @@ + ++++ +title = "adidoks" +description = "AdiDoks is a Zola theme helping you build modern documentation." +template = "theme.html" +date = 2021-05-06T02:57:59+08:00 + +[extra] +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 +repository = "https://github.com/aaranxu/adidoks.git" +homepage = "https://github.com/aaranxu/adidoks" +minimum_version = "0.13.0" +license = "MIT" +demo = "https://adidoks.netlify.app/" + +[extra.author] +name = "Aaran Xu" +homepage = "https://github.com/aaranxu" ++++ + +# Zola Theme AdiDoks + +AdiDoks is a mordern documentation theme, which is a port of the Hugo +theme [Doks](https://github.com/h-enk/doks) for Zola. + +## Demo + +[Live Preview](https://adidoks.netlify.app/). + +## Requirements + +Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.13.0. + +## Quick Start + +```bash +git clone git@github.com:aaranxu/adidoks.git +cd adidoks +zola serve +# open http://127.0.0.1:1111/ +``` + +Read more from [the document of the AdiDoks](https://adidoks.org/docs/getting-started/introduction/). + +## 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 AdiDoks + +Download this theme to your themes directory: + +```bash +cd mysite/themes +git clone git@github.com:aaranxu/adidoks.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 git@github.com:aaranxu/adidoks.git themes/adidoks +``` + +### Step 3: Configuration + +Enable the theme in your `config.toml` in the site derectory: + +```toml +theme = "adidoks" +``` + +Or copy the `config.toml.example` from the theme directory to your project's +root directory: + +```bash +cp themes/adidoks/config.toml.example config.toml +``` + +### Step 4: Add new content + +You can copy the content from the theme directory to your project: + +```bash +cp -r themes/adidoks/content . +``` + +You can modify or add new posts in the `content/blog`, `content/docs` 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 +``` + +AdiDoks 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 authors's taxonomies for the site. + +```toml +taxonomies = [ + {name = "authors"}, +] +``` + +Use search function for the content. + +```toml +build_search_index = true +``` + +#### Configuration options under the `extra` + +The following options should be under the `[extra]` in `config.toml` + +- `alanguage_code` - set HTML file language (default to `en-US`) +- `theme_color` - your site's HTML color (default to `#fff`) +- `title_separator` - the separator to your site title, like `|` and `-` (defaults to `|`) +- `title_addition` - the additon content for the title of the homepage +- `timeformat` - the timeformat for the blog article published date +- `timezone` - the timezone for the blog article published date +- `edit_page` (and `docs_repo`, `repo_branch`) - whether to show the edit page in the github repo for your docs +- `math` (and `library`) - set KaTeX or MathJax library +- `[extra.open]` - Open Graph + Twitter Cards for the site +- `[extra.schema]` - set JSON-LD for the site +- `[[extra.menu.main]]` - the header navigations for the site +- `[[extra.menu.social]]` - the social links on the header of the page +- `[extra.footer]` - the footer content on the left +- `[[extra.footer.nav]]` - the footer navigations on the right +- `[extra.home]` - the main content of the homepage +- `[[extra.home.list]]` - the lists' content of the homepage + + +### Templates + +All pages are extend to the `base.html`, and you can customize for as need. + +### Content + +#### Homepage + +Go to the `config.toml` to set your own homepage content. + +#### Sections + +Each section includes a `_index.md`, and you can customize it. + +#### Pages + +There are three types of pages in the site. + +- `blog` - blog article +- `docs` - documentation article +- `authors` - authors page if you need to add some information for a new author + +## Reporting Issues + +We use GitHub Issues as the official bug tracker for the **AdiDoks**. Please +search [existing issues](https://github.com/aaranxu/adidoks/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/aaranxu/adidoks/issues/new). + +## Contributing + +We'd love your help! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) to learn +about the kinds of contributions we're looking for. + +## License + +**AdiDoks** is distributed under the terms of the +[MIT license](https://github.com/aaranxu/adidoks/blob/main/LICENSE). + + \ No newline at end of file diff --git a/docs/content/themes/adidoks/screenshot.png b/docs/content/themes/adidoks/screenshot.png new file mode 100644 index 00000000..ae728d6a Binary files /dev/null and b/docs/content/themes/adidoks/screenshot.png differ diff --git a/docs/content/themes/after-dark/index.md b/docs/content/themes/after-dark/index.md index c1f7505d..51dfce1c 100644 --- a/docs/content/themes/after-dark/index.md +++ b/docs/content/themes/after-dark/index.md @@ -3,11 +3,11 @@ title = "after-dark" description = "A robust, elegant dark theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/getzola/after-dark.git" homepage = "https://github.com/getzola/after-dark" minimum_version = "0.11.0" diff --git a/docs/content/themes/anatole-zola/index.md b/docs/content/themes/anatole-zola/index.md index 88a1a788..92cce07d 100644 --- a/docs/content/themes/anatole-zola/index.md +++ b/docs/content/themes/anatole-zola/index.md @@ -3,11 +3,11 @@ title = "anatole-zola" description = "A port of farbox-theme-Anatole for zola" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/longfangsong/anatole-zola.git" homepage = "https://github.com/longfangsong/anatole-zola" minimum_version = "0.4.0" diff --git a/docs/content/themes/anpu/index.md b/docs/content/themes/anpu/index.md index a05ed6b1..63856dc8 100644 --- a/docs/content/themes/anpu/index.md +++ b/docs/content/themes/anpu/index.md @@ -3,11 +3,11 @@ title = "Anpu" description = "A port of the Hugo Anubis theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/zbrox/anpu-zola-theme.git" homepage = "https://github.com/zbrox/anpu-zola-theme" minimum_version = "0.11.0" diff --git a/docs/content/themes/book/index.md b/docs/content/themes/book/index.md index f820659d..d095e9af 100644 --- a/docs/content/themes/book/index.md +++ b/docs/content/themes/book/index.md @@ -3,11 +3,11 @@ title = "book" description = "A book theme inspired from GitBook/mdBook" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/getzola/book.git" homepage = "https://github.com/getzola/book" minimum_version = "0.5.0" diff --git a/docs/content/themes/clean-blog/index.md b/docs/content/themes/clean-blog/index.md index 60e33a41..9a273d6f 100644 --- a/docs/content/themes/clean-blog/index.md +++ b/docs/content/themes/clean-blog/index.md @@ -3,11 +3,11 @@ title = "Clean Blog" description = "A port of Start Bootstrap Clean Blog for Zola" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/dave-tucker/zola-clean-blog" homepage = "https://github.com/dave-tucker/zola-clean-blog" minimum_version = "0.4.0" diff --git a/docs/content/themes/codinfox-zola/index.md b/docs/content/themes/codinfox-zola/index.md index 6b88d47b..f9cb255c 100644 --- a/docs/content/themes/codinfox-zola/index.md +++ b/docs/content/themes/codinfox-zola/index.md @@ -3,11 +3,11 @@ title = "codinfox-zola" description = "Codinfox theme for Zola" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/svavs/codinfox-zola" homepage = "https://github.com/svavs/codinfox-zola" minimum_version = "0.11.0" diff --git a/docs/content/themes/dinkleberg/index.md b/docs/content/themes/dinkleberg/index.md index 3d27e963..f6f278b7 100644 --- a/docs/content/themes/dinkleberg/index.md +++ b/docs/content/themes/dinkleberg/index.md @@ -3,11 +3,11 @@ title = "dinkleberg" description = "The Rust BR theme for Gutenberg" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/rust-br/dinkleberg.git" homepage = "https://github.com/rust-br/dinkleberg" minimum_version = "0.4.0" diff --git a/docs/content/themes/docsascode-theme/index.md b/docs/content/themes/docsascode-theme/index.md index c681bbe1..a932caaf 100644 --- a/docs/content/themes/docsascode-theme/index.md +++ b/docs/content/themes/docsascode-theme/index.md @@ -3,11 +3,11 @@ title = "Docsascode_theme" description = "A modern simple Zola's theme related to docs as code methodology" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/codeandmedia/zola_docsascode_theme.git" homepage = "https://github.com/codeandmedia/zola_docsascode_theme" minimum_version = "0.10.0" diff --git a/docs/content/themes/dose/index.md b/docs/content/themes/dose/index.md new file mode 100644 index 00000000..d580fe95 --- /dev/null +++ b/docs/content/themes/dose/index.md @@ -0,0 +1,108 @@ + ++++ +title = "dose" +description = "a small blog theme" +template = "theme.html" +date = 2021-05-06T02:57:59+08:00 + +[extra] +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 +repository = "https://github.com/oltd/dose.git" +homepage = "https://github.com/oltd/dose" +minimum_version = "0.13.0" +license = "MIT" +demo = "https://oltd.github.io/dose" + +[extra.author] +name = "oltd" +homepage = "https://oltd.dev" ++++ + +# dose + +![](screenshot.png?raw=true) + +## Installation + +First download this theme to your `themes` directory: + +```bash +cd themes +git clone https://github.com/oltd/dose.git +``` + +and then enable it in your `config.toml`: + +```toml +theme = "dose" +``` + +The following taxonomies are enabled: + +```toml +taxonomies = [ + {name = "tags"}, +] +``` + +And the theme uses the following extras: + +```toml +[extra] +social_media = [ + {name = "GitHub", url = "https://github.com/oltd"}, + {name = "Twitter", url = "https://twitter.com/@oltd_maker"}, +] +``` + +The description of yourself with your image, you can modify by using a template. Just create a new +file `myblog/parts/me.html`: + +```html + +

Hi, this is me. I write about microcontrollers, programming and cloud software. ...

+``` + +If you want to have all pages sorted by their date, please create `myblog/content/_index.md`: +``` ++++ +sort_by = "date" ++++ +``` + +### About + +#### Inspired +I created this theme mainly for my personal website. You are free to use it or modify it. It is inspired by the [`no-style-please`](https://riggraz.dev/no-style-please/) jekyll theme. + +#### Typography + +This theme uses no special font, just the browsers default monospace font. Yes, this can mean that the website could be rendered differently, but users can freely choose their webfont. + +#### Darkmode + +This theme supports dark and light mode. Currently this will be only switched based on the users preffered system theme. But a manual switch will follow in the future in the footer (see the todo). + +| light | dark | +|-|-| +| ![](screenshot-light.png) | ![](screenshot-dark.png) | + +#### Size + +We need about `2kB` extra stuff aside from images and raw html. This is divided up to `1.7kB CSS` and `~300B JS`. + +#### Syntax Highlighting + +As I didn't want to invest any time in creating an own syntax color schema for this theme, I suggest to use `visual-studio-dark`, which is the same one used in the demo page. + +### TODO + +- [ ] introduce sass variables for colors +- [ ] dark/light switch with javascript and store in browser session + +## License + +![GitHub](https://img.shields.io/github/license/oltd/dose) + + \ No newline at end of file diff --git a/docs/content/themes/dose/screenshot.png b/docs/content/themes/dose/screenshot.png new file mode 100644 index 00000000..6eb257c4 Binary files /dev/null and b/docs/content/themes/dose/screenshot.png differ diff --git a/docs/content/themes/even/index.md b/docs/content/themes/even/index.md index 9e388949..ce0d790d 100644 --- a/docs/content/themes/even/index.md +++ b/docs/content/themes/even/index.md @@ -3,11 +3,11 @@ title = "even" description = "A robust, elegant dark theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/getzola/even.git" homepage = "https://github.com/getzola/even" minimum_version = "0.11.0" diff --git a/docs/content/themes/feather/index.md b/docs/content/themes/feather/index.md index 18f47b8b..222b2d71 100644 --- a/docs/content/themes/feather/index.md +++ b/docs/content/themes/feather/index.md @@ -3,11 +3,11 @@ title = "feather" description = "A modern blog theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/piedoom/feather" homepage = "https://github.com/piedoom/feather" minimum_version = "0.5.1" diff --git a/docs/content/themes/float/index.md b/docs/content/themes/float/index.md index dce904b0..8908593a 100644 --- a/docs/content/themes/float/index.md +++ b/docs/content/themes/float/index.md @@ -3,11 +3,11 @@ title = "Float" description = "An elegant blog theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://gitlab.com/float-theme/float.git" homepage = "https://float-theme.netlify.app/" minimum_version = "0.11.0" diff --git a/docs/content/themes/hallo/index.md b/docs/content/themes/hallo/index.md index ff5a3d3e..a821c508 100644 --- a/docs/content/themes/hallo/index.md +++ b/docs/content/themes/hallo/index.md @@ -3,11 +3,11 @@ title = "hallo" description = "A single-page theme to introduce yourself." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/flyingP0tat0/zola-hallo.git" homepage = "https://github.com/janbaudisch/zola-hallo" minimum_version = "0.4.0" diff --git a/docs/content/themes/hyde/index.md b/docs/content/themes/hyde/index.md index 46afc0c8..546f1023 100644 --- a/docs/content/themes/hyde/index.md +++ b/docs/content/themes/hyde/index.md @@ -3,11 +3,11 @@ title = "hyde" description = "A classic blog theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/getzola/hyde.git" homepage = "https://github.com/getzola/hyde" minimum_version = "0.11.0" diff --git a/docs/content/themes/juice/index.md b/docs/content/themes/juice/index.md index 03951a44..bd417a4e 100644 --- a/docs/content/themes/juice/index.md +++ b/docs/content/themes/juice/index.md @@ -3,11 +3,11 @@ title = "juice" description = "An intuitive, elegant, and lightweight Zola theme for product sites." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/huhu/juice" homepage = "https://github.com/huhu/juice" minimum_version = "0.11.0" diff --git a/docs/content/themes/lightspeed/index.md b/docs/content/themes/lightspeed/index.md index 8f2de073..59601733 100644 --- a/docs/content/themes/lightspeed/index.md +++ b/docs/content/themes/lightspeed/index.md @@ -3,11 +3,11 @@ title = "lightspeed" description = "Zola theme with a perfect Lighthouse score" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/carpetscheme/lightspeed" homepage = "https://github.com/carpetscheme/lightspeed" minimum_version = "0.10.0" diff --git a/docs/content/themes/oceanic-zen/index.md b/docs/content/themes/oceanic-zen/index.md index a38a6242..a8806b14 100644 --- a/docs/content/themes/oceanic-zen/index.md +++ b/docs/content/themes/oceanic-zen/index.md @@ -3,11 +3,11 @@ title = "Oceanic Zen" description = "Minimalistic blog theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/barlog-m/oceanic-zen.git" homepage = "https://github.com/barlog-m/oceanic-zen" minimum_version = "0.12.0" diff --git a/docs/content/themes/sam/index.md b/docs/content/themes/sam/index.md index c406d859..97c6791d 100644 --- a/docs/content/themes/sam/index.md +++ b/docs/content/themes/sam/index.md @@ -3,11 +3,11 @@ title = "sam" description = "A Simple and Minimalist theme with a focus on typography and content." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/janbaudisch/zola-sam.git" homepage = "https://github.com/janbaudisch/zola-sam" minimum_version = "0.4.0" diff --git a/docs/content/themes/simple-dev-blog/index.md b/docs/content/themes/simple-dev-blog/index.md index 67df99cf..7a5fa945 100644 --- a/docs/content/themes/simple-dev-blog/index.md +++ b/docs/content/themes/simple-dev-blog/index.md @@ -3,11 +3,11 @@ title = "simple-dev-blog" description = "A simple dev blog theme with no javascript, prerendered linked pages and SEO tags." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/bennetthardwick/simple-dev-blog-zola-starter" homepage = "https://github.com/bennetthardwick/simple-dev-blog-zola-starter" minimum_version = "0.4.0" diff --git a/docs/content/themes/slim/index.md b/docs/content/themes/slim/index.md index 6cfedfe5..ae97b734 100644 --- a/docs/content/themes/slim/index.md +++ b/docs/content/themes/slim/index.md @@ -3,11 +3,11 @@ title = "Slim" description = "Slim is a minimal, clean and beautiful theme for Zola." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/jameshclrk/zola-slim" homepage = "https://github.com/jameshclrk/zola-slim" minimum_version = "0.8.0" diff --git a/docs/content/themes/solar-theme-zola/index.md b/docs/content/themes/solar-theme-zola/index.md index d9f733ba..79d553bd 100644 --- a/docs/content/themes/solar-theme-zola/index.md +++ b/docs/content/themes/solar-theme-zola/index.md @@ -3,11 +3,11 @@ title = "solar-theme-zola" description = "A port of solar-theme-hugo for zola" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/hulufei/solar-theme-zola.git" homepage = "https://github.com/hulufei/solar-theme-zola" minimum_version = "0.4.0" diff --git a/docs/content/themes/toucan/index.md b/docs/content/themes/toucan/index.md index f9307f86..a02b4396 100644 --- a/docs/content/themes/toucan/index.md +++ b/docs/content/themes/toucan/index.md @@ -3,11 +3,11 @@ title = "Toucan" description = "Inspired from Pelican default theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://git.42l.fr/HugoTrentesaux/toucan.git" homepage = "https://git.42l.fr/HugoTrentesaux/toucan" minimum_version = "0.8.0" diff --git a/docs/content/themes/zerm/index.md b/docs/content/themes/zerm/index.md index 81959a70..de473b28 100644 --- a/docs/content/themes/zerm/index.md +++ b/docs/content/themes/zerm/index.md @@ -3,11 +3,11 @@ title = "zerm" description = "A minimalistic and dark theme based on Radek Kozieł's theme for Hugo" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/ejmg/zerm.git" homepage = "https://github.com/ejmg/zerm" minimum_version = "0.8.0" diff --git a/docs/content/themes/zola-henry/index.md b/docs/content/themes/zola-henry/index.md index a054ecee..531845b0 100644 --- a/docs/content/themes/zola-henry/index.md +++ b/docs/content/themes/zola-henry/index.md @@ -3,11 +3,11 @@ title = "henry" description = "A timeless blog theme" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/sirodoht/zola-henry" homepage = "https://github.com/sirodoht/zola-henry" minimum_version = "0.4.0" diff --git a/docs/content/themes/zola-paper/index.md b/docs/content/themes/zola-paper/index.md index 70803a9a..403fcf17 100644 --- a/docs/content/themes/zola-paper/index.md +++ b/docs/content/themes/zola-paper/index.md @@ -3,11 +3,11 @@ title = "zola-paper" description = "A clean theme inspired from hugo-paper." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/schoenenberg/zola-paper.git" homepage = "https://github.com/schoenenberg/zola-paper" minimum_version = "0.11.0" diff --git a/docs/content/themes/zola-pickles/index.md b/docs/content/themes/zola-pickles/index.md index e5c51dcf..405df95f 100644 --- a/docs/content/themes/zola-pickles/index.md +++ b/docs/content/themes/zola-pickles/index.md @@ -3,11 +3,11 @@ title = "pickles" description = "A modern, simple, clean blog theme for Zola." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/lukehsiao/zola-pickles.git" homepage = "https://github.com/lukehsiao/zola-pickles" minimum_version = "0.13.0" diff --git a/docs/content/themes/zola-theme-hikari/index.md b/docs/content/themes/zola-theme-hikari/index.md index ecfd621b..bc6bc1f2 100644 --- a/docs/content/themes/zola-theme-hikari/index.md +++ b/docs/content/themes/zola-theme-hikari/index.md @@ -3,11 +3,11 @@ title = "Hikari" description = "Fluid, responsive blog theme for Zola" template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/waynee95/zola-theme-hikari" homepage = "https://github.com/waynee95/zola-theme-hikari" minimum_version = "0.5.1" diff --git a/docs/content/themes/zola.386/index.md b/docs/content/themes/zola.386/index.md index 61cbc7eb..f9a3ffdf 100644 --- a/docs/content/themes/zola.386/index.md +++ b/docs/content/themes/zola.386/index.md @@ -3,11 +3,11 @@ title = "zola.386" description = "Zola port of the BOOTSTRA.386 theme." template = "theme.html" -date = 2021-02-18T22:27:50+01:00 +date = 2021-05-06T02:57:59+08:00 [extra] -created = 2021-02-18T22:27:50+01:00 -updated = 2021-02-18T22:27:50+01:00 +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 repository = "https://github.com/lopes/zola.386" homepage = "https://github.com/lopes/zola.386" minimum_version = "0.10.1" diff --git a/docs/content/themes/zola_easydocs_theme/index.md b/docs/content/themes/zola_easydocs_theme/index.md new file mode 100644 index 00000000..8683eafa --- /dev/null +++ b/docs/content/themes/zola_easydocs_theme/index.md @@ -0,0 +1,41 @@ + ++++ +title = "EasyDocs" +description = "An easy way to create docs for your project" +template = "theme.html" +date = 2021-05-06T02:57:59+08:00 + +[extra] +created = 2021-05-06T02:57:59+08:00 +updated = 2021-05-06T02:57:59+08:00 +repository = "https://github.com/codeandmedia/zola_easydocs_theme.git" +homepage = "https://github.com/codeandmedia/zola_easydocs_theme" +minimum_version = "0.13.0" +license = "MIT" +demo = "https://easydocs.codeandmedia.com" + +[extra.author] +name = "Roman Soldatenkov" +homepage = "https://codeandmedia.com" ++++ + +## An easy way to create a document library for your project + +Demo: [https://easydocs.codeandmedia.com/](https://easydocs.codeandmedia.com/) + +This theme for [Zola](https://getzola.org) (static site engine) helps you build and publish your project docs easily and fast. Zola is just one binary that outputs html-pages and additional static assets after building your docs written in Markdown. Thus, you can take the theme, your md-files, Zola and gain flexible and simple website for documentation. + +### Step-by-step + +As you may have heard Zola is quite flexible :) So, the scenario below is one of hundreds possible ways to make things done, feel free to find your best. Also, Zola provides their own mechanism to install and use themes, see [the docs](https://www.getzola.org/documentation/themes/installing-and-using-themes/). + +1. Fork the repo and replace demo-content inside content folder with yours. But take a look to _index.md files. It contains `title` and when you want to have anchor right of your headers add `insert_anchor_links = "right"` to each index. `theme.toml`, screenshot and readme may be deleted too. +2. Inside `config.toml` change URL and title on your own. In extra section you can specify path to your GitHub API for version below the logo on nav, favicon and logo itself. Or just remove the lines if you don't need it. Also, you can configure or turn on some additional settings related to Zola. [Specification is here](https://www.getzola.org/documentation/getting-started/configuration/). +3. In sass/_variables.scss you may change font, color or backgound if you want. +4. Almost done. Now, you should decide how you want to build and where will be hosted your website. You can build it locally and upload to somewhere. Or build in GitHub Actions and host on GitHub Pages / Netlify / CloudFlare Pages / AnyS3CloudStorage. [Howto for GitHub Pages](https://www.getzola.org/documentation/deployment/github-pages/). [My example](https://github.com/o365hq/o365hq.com/blob/main/.github/workflows/main.yml) of GitHub workflow with 2-steps build (the first checks for links and spelling errors, the second uploads to Azure). [Dockerfile](https://github.com/codeandmedia/zola_docsascode_theme/blob/master/Dockerfile) to make Docker image. + +Enjoy your docs! + +* _Icons: [Office UI Fabric Icons](https://uifabricicons.azurewebsites.net/)_ +* _Copy-code-button: [Aaron Luna](https://aaronluna.dev/blog/add-copy-button-to-code-blocks-hugo-chroma/)_ + \ No newline at end of file diff --git a/docs/content/themes/zola_easydocs_theme/screenshot.png b/docs/content/themes/zola_easydocs_theme/screenshot.png new file mode 100644 index 00000000..fd7496ad Binary files /dev/null and b/docs/content/themes/zola_easydocs_theme/screenshot.png differ