a new Zola theme AdiDoks

.gitignore

@@ -0,0 +1,3 @@
+public
+.vs
+.vscode

CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+We'd love your help! Thanks for caring about the theme of Zola.
+
+## Licensing
+
+This repository is under the MIT license. You can find the full text of the [license](./LICENSE) in this repository.
+
+## Code of Conduct
+
+The AdiDoks theme has a [code of conduct](./CODE_OF_CONDUCT.md) that governs all sub-projects, including this one. Please respect it!
+
+## Contribute to Doks
+
+- Follow the [GitHub flow](https://guides.github.com/introduction/flow/).
+- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
+
+## Create an issue
+
+- [Bug report](https://github.com/aaranxu/adidoks/issues/new?template=bug-report---.md)
+- [Feature request](https://github.com/aaranxu/adidoks/issues/new?template=feature-request---.md)
+
+## Improve documentation
+
+👉 The documentation lives in [`./content/docs/`](https://github.com/aaranxu/adidoks/tree/master/content/docs) of the [`adidoks` repository](https://github.com/h-enk/getdoks.org).
+
+- Follow the [GitHub flow](https://guides.github.com/introduction/flow/).
+- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Aaran Xu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,174 @@
+# 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 [email protected]: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 [email protected]:aaranxu/adidoks.git
+```
+
+Or install as a submodule:
+
+```bash
+cd mysite
+git init
+git submodule add [email protected]: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).