Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
BERADQ committed Mar 24, 2024
1 parent c63b0b8 commit 7f5d792
Show file tree
Hide file tree
Showing 10 changed files with 107 additions and 228 deletions.
2 changes: 1 addition & 1 deletion content/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Docs"
description = "The documents of the AdiDoks theme."
description = "The documents of the Kokoro."
date = 2025-05-01T08:00:00+00:00
updated = 2021-05-01T08:00:00+00:00
sort_by = "weight"
Expand Down
4 changes: 2 additions & 2 deletions content/docs/default-implement/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
+++
title = "默认实现"
description = "Find out how to contribute to AdiDoks."
description = "关于 Kokoro 的默认实现"
date = 2025-05-01T18:00:00+00:00
updated = 2021-05-01T18:00:00+00:00
template = "docs/section.html"
sort_by = "weight"
weight = 4
weight = 3
draft = false
+++
135 changes: 3 additions & 132 deletions content/docs/default-implement/plugin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "关于插件"
description = "Contributor Covenant Code of Conduct."
description = "关于插件系统。"
date = 2021-05-01T18:20:00+00:00
updated = 2021-05-01T18:20:00+00:00
draft = false
Expand All @@ -9,138 +9,9 @@ sort_by = "weight"
template = "docs/page.html"

[extra]
lead = "Contributor Covenant Code of Conduct."
lead = "插件系统可以实现弱耦合,模块化,模块可独立开发、测试、维护。"
toc = true
top = false
+++

## 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
## 还没有写
2 changes: 1 addition & 1 deletion content/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "从这里开始"
description = "Quick start and guides for installing the AdiDoks theme on your preferred operating system."
description = "开始"
date = 2025-05-01T08:00:00+00:00
updated = 2021-05-01T08:00:00+00:00
template = "docs/section.html"
Expand Down
81 changes: 10 additions & 71 deletions content/docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "快速开始"
description = "One page summary of how to start a new AdiDoks project."
description = "使用 Kokoro 完成一个最简单的 Web 服务器吧!"
date = 2021-05-01T08:20:00+00:00
updated = 2021-05-01T08:20:00+00:00
draft = false
Expand All @@ -9,86 +9,25 @@ sort_by = "weight"
template = "docs/page.html"

[extra]
lead = "One page summary of how to start a new AdiDoks project."
lead = "使用 Kokoro 完成一个最简单的 Web 服务器吧!"
toc = true
top = false
+++

## Requirements
## 环境搭建

Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.15.0.
首先你需要 Rust 开发环境,这里不再过多赘述。

## Run the Theme Directly
创建一个项目。

```bash
git clone https://github.com/aaranxu/adidoks.git
cd adidoks
zola serve
```

Visit `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 AdiDoks

Download this theme to your themes directory:

```bash
cd mysite/themes
git clone https://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 https://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:
你可以使用 Cargo 来管理依赖,使用以下指令将 Kokoro 作为依赖添加到你的项目中。

```bash
cp -r themes/adidoks/content .
cargo add kokoro
```

You can modify or add new posts in the `content/blog`, `content/docs` or other
content directories as needed.
然后在你需要用到 kokoro 的地方引入它。

### Step 5: Run the project

Just run `zola serve` in the root path of the project:

```bash
zola serve
```rust
use kokoro::prelude::*;
```

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.
4 changes: 2 additions & 2 deletions content/docs/help/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
+++
title = "帮助"
description = "Get help on AdiDoks."
description = "获取帮助"
date = 2025-05-01T19:00:00+00:00
updated = 2021-05-01T19:00:00+00:00
template = "docs/section.html"
sort_by = "weight"
weight = 5
weight = 4
draft = false
+++
28 changes: 11 additions & 17 deletions content/docs/help/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,25 @@ sort_by = "weight"
template = "docs/page.html"

[extra]
lead = "Answers to frequently asked questions."
toc = true
top = false
+++

## What is the AdiDoks?
## Kokoro 到底是什么?

AdiDoks is a Zola theme for Documentation's sites, ported by the Hugo Theme
[Doks](https://getdoks.org), which is a pretty nice theme. Thanks a lot to
[*h-enk*](https://github.com/h-enk), the creator of the [Doks](https://getdoks.org).
请看 [关于 Kokoro-core](../../getting-started/about-core)

## Keyboard shortcuts for search?
## 这个网站怎么如此垃圾?

- focus: `/`
- select: `` and ``
- open: `Enter`
- close: `Esc`
亲,还没写完呢。

## Other documentation?
## 哪里可以找到更完整的文档?

- [Netlify](https://docs.netlify.com/)
- [Zola](https://www.getzola.org/documentation/getting-started/overview/)
- [docs.rs](https://docs.rs/)
- [docs.rs/kokoro](https://docs.rs/kokoro/latest/kokoro/)

## Contact the creator?
## 在哪里提问?

Send *Aaran Xu* an E-mail:

- <aaranxu@outlook.com>
- <[email protected]>
- [QQ群](../qq-group)
- [Github 仓库](https://github.com/kokoro-rs/kokoro/)
4 changes: 2 additions & 2 deletions content/docs/help/qq-group.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "QQ 群"
description = "Answers to frequently asked questions."
description = "交流场所"
date = 2021-05-01T19:30:00+00:00
updated = 2021-05-01T19:30:00+00:00
draft = false
Expand All @@ -9,7 +9,7 @@ sort_by = "weight"
template = "docs/page.html"

[extra]
lead = "Answers to frequently asked questions."
lead = "Kokoro 交流群:787163897"
toc = true
top = false
+++
10 changes: 10 additions & 0 deletions content/docs/try-start/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
+++
title = "尝试一下"
description = "尝试编写简单的 Web 服务器"
date = 2025-05-01T19:00:00+00:00
updated = 2021-05-01T19:00:00+00:00
template = "docs/section.html"
sort_by = "weight"
weight = 2
draft = false
+++
Loading

0 comments on commit 7f5d792

Please sign in to comment.