first commit

.envrc

@@ -0,0 +1 @@
+use nix

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/adidoks"]
+	path = themes/adidoks
+	url = https://github.com/aaranxu/adidoks.git

config.toml

@@ -0,0 +1,127 @@
+# The URL the site will be built for
+base_url = "https://clan.lol"
+title = "Clan"
+
+# The site theme to use.
+theme = "adidoks"
+
+# The default language; used in feeds and search index
+# Note: the search index doesn't support Chinese/Japanese/Korean Languages
+default_language = "en"
+
+# Whether to automatically compile all Sass files in the sass directory
+compile_sass = true
+
+# Whether to generate a feed file for the site
+generate_feed = true
+
+# When set to "true", the generated HTML files are minified.
+minify_html = false
+
+# The taxonomies to be rendered for the site and their configuration.
+taxonomies = [
+  {name = "authors"}, # Basic definition: no feed or pagination
+]
+
+# Whether to build a search index to be used later on by a JavaScript library
+# When set to "true", a search index is built from the pages and section
+# content for `default_language`.
+build_search_index = true
+
+[search]
+# Whether to include the title of the page/section in the index
+include_title = true
+# Whether to include the description of the page/section in the index
+include_description = false
+# Whether to include the rendered content of the page/section in the index
+include_content = true
+
+[markdown]
+# Whether to do syntax highlighting.
+# Theme can be customised by setting the `highlight_theme`
+# variable to a theme supported by Zola
+highlight_code = true
+
+[extra]
+# Put all your custom variables here
+author = "Clan contributors"
+email = "admin@clan.lol"
+
+# If running on netlify.app site, set to true
+is_netlify = false
+
+# Set HTML file language
+language_code = "en-US"
+
+# Set theme-color meta tag for Chrome browser
+theme_color = "#fff"
+
+# More about site's title
+title_separator = "-"  # set as |, -, _, etc
+title_addition = "Build your own cLan"
+
+
+# Set date format in blog publish metadata
+timeformat = "%B %e, %Y" # e.g. June 14, 2021
+timezone = "America/New_York"
+
+# Edit page on reposity or not
+edit_page = false
+docs_repo = "https://git.clan.lol/Mic92/adidoks"
+repo_branch = "main"
+
+## Math settings
+# options: true, false. Enable math support globally,
+# default: false. You can always enable math on a per page.
+math = false
+library = "katex"  # options: "katex", "mathjax". default is "katex".
+
+## Open Graph + Twitter Cards
+[extra.open]
+enable = true
+# this image will be used as fallback if a page has no image of its own
+image = "doks.png"
+og_locale = "en_US"
+twitter_site = ""
+twitter_creator = ""
+facebook_author = ""
+facebook_publisher = ""
+
+## JSON-LD
+[extra.schema]
+type = "Organization"
+logo = "logo-doks.png"
+twitter = ""
+linked_in = ""
+github = "https://github.com/aaranxu"
+section = "blog" # see config.extra.main~url
+## Sitelinks Search Box
+site_links_search_box = false
+
+
+# Menu items
+[[extra.menu.main]]
+name = "Docs"
+section = "docs"
+url = "/docs/getting-started/introduction/"
+weight = 10
+
+[[extra.menu.main]]
+name = "Blog"
+section = "blog"
+url = "/blog/"
+weight = 20
+
+# Footer contents
+[extra.footer]
+info = 'Powered by <a href="https://www.getzola.org/">Zola</a>, and <a href="https://github.com/aaranxu/adidoks">AdiDoks</a>'
+
+[[extra.footer.nav]]
+name = "Privacy"
+url = "/privacy-policy/"
+weight = 10
+
+[[extra.footer.nav]]
+name = "Code of Conduct"
+url = "/docs/contributing/code-of-conduct/"
+weight = 20

content/_index.md

@@ -0,0 +1,39 @@
++++
+title = "Build your own cLan"
+
+
+# The homepage contents
+[extra]
+lead = '<b>cLan</b> envisions a new model for a decentralized network, designed to provide families, smaller groups, and small businesses a platform that’s private, secure, and user-friendly.'
+url = "/docs/getting-started/introduction/"
+url_button = "Learn more"
+repo_version = "Clan v0.0.0-alpha"
+repo_license = "Open-source MIT License."
+repo_url = "https://git.clan.lol/clan/"
+
+# Menu items
+[[extra.menu.main]]
+name = "Docs"
+section = "docs"
+url = "/docs/getting-started/introduction/"
+weight = 10
+
+[[extra.menu.main]]
+name = "Blog"
+section = "blog"
+url = "/blog/"
+weight = 20
+
+[[extra.list]]
+title = "Security aware"
+content = 'Write some description why.'
+
+[[extra.list]]
+title = "Easy to use"
+content = 'Write some description why.'
+
+[[extra.list]]
+title = "Yet another point"
+content = 'Write some description why.'
+
++++

content/authors/Mic92.md

@@ -0,0 +1,11 @@
++++
+title = "Mic92"
+description = "Contributor to Clan."
+date = 2021-04-01T08:50:45+00:00
+updated = 2021-04-01T08:50:45+00:00
+draft = false
++++
+
+Contributor to **clan**.
+
+[@thalheim](https://thalheim.io)

content/authors/_index.md

@@ -0,0 +1,18 @@
++++
+title = "Authors"
+description = "The authors of the blog articles."
+date = 2021-04-01T08:00:00+00:00
+updated = 2021-04-01T08:00:00+00:00
+draft = false
+
+# If add a new author page in this section, please add a new item,
+# and the format is as follows:
+#
+# "author-name-in-url" = "the-full-path-of-the-author-page"
+#
+# Note: We use quoted keys here.
+[extra.author_pages]
+"Mic92" = "authors/Mic92.md"
++++
+
+The authors of the blog articles.

content/blog/_index.md

@@ -0,0 +1,7 @@
++++
+title = "Blog"
+description = "Blog"
+sort_by = "date"
+paginate_by = 2
+template = "blog/section.html"
++++

content/blog/hello-world.md

@@ -0,0 +1,15 @@
++++
+title = "Hello World"
+description = "Introducing Clan, a new model for a decentralized network, designed to provide families, smaller groups, and small businesses a platform that’s private, secure, and user-friendly."
+date = 2021-05-01T09:19:42+00:00
+updated = 2021-05-01T09:19:42+00:00
+draft = false
+template = "blog/page.html"
+
+[taxonomies]
+authors = ["Mic92"]
+
+[extra]
+lead = "A blog post introducing the project."
++++
+Some more text

content/docs/_index.md

@@ -0,0 +1,9 @@
++++
+title = "Docs"
+description = "The documents of the AdiDoks theme."
+date = 2025-05-01T08:00:00+00:00
+updated = 2021-05-01T08:00:00+00:00
+sort_by = "weight"
+weight = 1
+template = "docs/section.html"
++++

content/docs/contributing/_index.md

@@ -0,0 +1,10 @@
++++
+title = "Contributing"
+description = "Find out how to contribute to Clan."
+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
+draft = false
++++

content/docs/contributing/code-of-conduct.md

@@ -0,0 +1,146 @@
++++
+title = "Code of Conduct"
+description = "Contributor Covenant Code of Conduct."
+date = 2021-05-01T18:20:00+00:00
+updated = 2021-05-01T18:20:00+00:00
+draft = false
+weight = 420
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = "Contributor Covenant Code of Conduct."
+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
+<aaranxu@outlook.com>.
+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

content/docs/contributing/how-to-contribute.md

@@ -0,0 +1,30 @@
++++
+title = "How to Contribute"
+description = "Contribute to Clan, improve documentation, or submit to showcase."
+date = 2021-05-01T18:10:00+00:00
+updated = 2021-05-01T18:10:00+00:00
+draft = false
+weight = 410
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = "Contribute to Clan, improve documentation, or submit to showcase."
+toc = true
+top = false
++++
+
+👉 Make sure to read the [Code of Conduct](../code-of-conduct/).
+
+## Contribute to Doks
+
+👉 The Clan code lives in the [`clan` repository](https://git.clan.lol/clan/clan)
+
+### Create an issue
+
+- <TODO>
+
+## Improve documentation
+
+👉 The documentation lives in [`./docs/`](https://git.clan.lol/clan/clan/docs)
+of the [`clan` repository](https://git.clan.lol/clan/clan/docs).

content/docs/getting-started/_index.md

@@ -0,0 +1,10 @@
++++
+title = "Getting Started"
+description = "Quick start and guides for installing the AdiDoks theme on your preferred operating system."
+date = 2025-05-01T08:00:00+00:00
+updated = 2021-05-01T08:00:00+00:00
+template = "docs/section.html"
+sort_by = "weight"
+weight = 1
+draft = false
++++

content/docs/getting-started/introduction.md

@@ -0,0 +1,31 @@
++++
+title = "Introduction"
+description = "AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola."
+date = 2021-05-01T08:00:00+00:00
+updated = 2021-05-01T08:00:00+00:00
+draft = false
+weight = 10
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = 'AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme <a href="https://github.com/h-enk/doks">Doks</a> for Zola.'
+toc = true
+top = false
++++
+
+## Quick Start
+
+One page summary of how to start a new AdiDoks project. [Quick Start →](../quick-start/)
+
+## Go further
+
+Contributing and Help.
+
+## Contributing
+
+Find out how to contribute to Doks. [Contributing →](../../contributing/how-to-contribute/)
+
+## Help
+
+Get help on Doks. [Help →](../../help/faq/)

content/docs/getting-started/quick-start.md

@@ -0,0 +1,94 @@
++++
+title = "Quick Start"
+description = "One page summary of how to start a new AdiDoks project."
+date = 2021-05-01T08:20:00+00:00
+updated = 2021-05-01T08:20:00+00:00
+draft = false
+weight = 20
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = "One page summary of how to start a new AdiDoks project."
+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.
+
+## 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:
+
+```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.

content/docs/help/_index.md

@@ -0,0 +1,10 @@
++++
+title = "Help"
+description = "Get help on AdiDoks."
+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
+draft = false
++++

content/docs/help/faq.md

@@ -0,0 +1,32 @@
++++
+title = "FAQ"
+description = "Answers to frequently asked questions."
+date = 2021-05-01T19:30:00+00:00
+updated = 2021-05-01T19:30:00+00:00
+draft = false
+weight = 30
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = "Answers to frequently asked questions."
+toc = true
+top = false
++++
+
+## Keyboard shortcuts for search?
+
+- focus: `/`
+- select: `↓` and `↑`
+- open: `Enter`
+- close: `Esc`
+
+## Other documentation?
+
+- [https://nixos.org](https://nixos.org/)
+
+## Contact the creator?
+
+Send an E-mail:
+
+- <admins@clan.lol>

content/privacy-policy/_index.md

@@ -0,0 +1,27 @@
++++
+title = "Privacy Policy"
+description = "We do not use cookies and we do not collect any personal data."
+date = 2021-05-01T08:00:00+00:00
+updated = 2020-05-01T08:00:00+00:00
+draft = false
+
+[extra]
+class = "page single"
++++
+
+__TLDR__: We do not use cookies and we do not collect any personal data.
+
+## Website visitors
+
+- No personal information is collected.
+- No information is stored in the browser.
+- No information is shared with, sent to or sold to third-parties.
+- No information is shared with advertising companies.
+- No information is mined and harvested for personal and behavioral trends.
+- No information is monetized.
+
+## Contact us
+
+[Contact us](mailto:admin@clan.lol) if you have any questions.
+
+Effective Date: _4th July 2023_

default.nix

@@ -0,0 +1,7 @@
+with import <nixpkgs> {};
+mkShell {
+  packages = [
+    bashInteractive
+    zola
+  ];
+}

themes/adidoks

@@ -0,0 +1 @@
+Subproject commit 5c698271c460046034605b743a15196b12e32887