Config0

2023-10-10 19:40:07 +00:00 · 2023-10-10 19:40:07 +00:00 · 71e515accc
commit 71e515accc
22 changed files with 1013 additions and 0 deletions
--- a/config.toml
+++ b/config.toml
@ -0,0 +1,143 @@
 # The URL the site will be built for
 base_url = "https://adidoks.netlify.com"
 title = "AdiDoks"
 description = "AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola."
 # 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 = "Aaran Xu"
 github = "https://github.com/aaranxu"
 twitter = "https://twitter.com/aaranxu"
 email = "aaranxu@outlook.com"
 # If running on netlify.app site, set to true
 is_netlify = true
 # 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 = "Modern Documentation Theme"
 # 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://github.com/aaranxu/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"
 twitter_site = "aaranxu"
 twitter_creator = "aaranxu"
 facebook_author = "ichunyun"
 facebook_publisher = "ichunyun"
 og_locale = "en_US"
 ## JSON-LD
 [extra.schema]
 type = "Organization"
 logo = "logo-doks.png"
 twitter = "https://twitter.com/aaranxu"
 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
 [[extra.menu.social]]
 name = "Twitter"
 pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-twitter"><path d="M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z"></path></svg>'
 url = "https://twitter.com/aaranxu"
 weight = 10
 [[extra.menu.social]]
 name = "GitHub"
 pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path></svg>'
 url = "https://github.com/aaranxu/adidoks"
 post = "v0.1.0"
 weight = 20
 # Footer contents
 [extra.footer]
 info = 'Powered by <a href="https://www.netlify.com/">Netlify</a>, <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
--- a/content/_index.fi.md
+++ b/content/_index.fi.md
@ -0,0 +1,51 @@
 +++
 title = "Nykyaikainen teema dokumentaatiolle"
 # The homepage contents
 [extra]
 lead = '<b>AdiDoks</b> on nykyaikainen teema dokumentaatiosivustoille. Se on portattu Zolalle Hugo-teemasta nimeltä <a href="https://github.com/h-enk/">Doks</a>.'
 url = "/docs/getting-started/introduction/"
 url_button = "Aloita"
 repo_version = "GitHub v0.1.0"
 repo_license = "Open-source MIT License."
 repo_url = "https://github.com/aaranxu/adidoks"
 # Menu items
 [[extra.menu.main]]
 name = "Dokumentaatio"
 section = "docs"
 url = "/docs/getting-started/introduction/"
 weight = 10
 [[extra.menu.main]]
 name = "Blogi"
 section = "blog"
 url = "/blog/"
 weight = 20
 [[extra.list]]
 title = "Turvallisuustietoinen"
 content = 'Saat A+-arvosanoja <a href="https://observatory.mozilla.org/analyze/adidoks.org">Mozilla Observatoryssä</a> suoraan. Voit vaihtaa turvallisuusheadereita tarpeidesi mukaan.'
 [[extra.list]]
 title = "Salamannopea ⚡️"
 content = 'Saat hyvät pisteet <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637">Google Lighthousessa</a> defaultina. Doks poistaa tarpeettomat css:t, esinoutaa linkit, ja lataa kuvat laiskasti.'
 [[extra.list]]
 title = "SEO-valmis"
 content = "Käytä järkeviä oletusarvoja rakenteiselle datalle, open graphille ja Twitter-korteille. Tai muunna SEO-asetukset mieleisiksesi helposti."
 [[extra.list]]
 title = "Fulltext-haku"
 content = "Tee hakuja sivuillesi FlexSearchilla. Muuntele indeksointiasetuksia mieleisiksesi helposti."
 [[extra.list]]
 title = "Sivujen layoutit"
 content = "Rakenna sivuja laskeutumisivun, blogisivun tai dokumentaatiolayoutin mukaan. Lisää osioita ja komponentteja tarpeen mukaan."
 [[extra.list]]
 title = "Dark mode"
 content = "Vaihda hämärässä käytettävään käyttöliittymäteemaan nappia painamalla. Muuta värit muuttujilla vastaamaan brändiäsi."
 +++
--- a/content/_index.md
+++ b/content/_index.md
@ -0,0 +1,51 @@
 +++
 title = "Modern Documentation Theme"
 # The homepage contents
 [extra]
 lead = '<b>AdiDoks</b> is a modern documentation theme, which is a port of the Hugo theme <a href="https://github.com/h-enk/">Doks</a> for Zola.'
 url = "/docs/getting-started/introduction/"
 url_button = "Get started"
 repo_version = "GitHub v0.1.0"
 repo_license = "Open-source MIT License."
 repo_url = "https://github.com/aaranxu/adidoks"
 # 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 = 'Get A+ scores on <a href="https://observatory.mozilla.org/analyze/adidoks.org">Mozilla Observatory</a> out of the box. Easily change the default Security Headers to suit your needs.'
 [[extra.list]]
 title = "Fast by default ⚡️"
 content = 'Get 100 scores on <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637">Google Lighthouse</a> by default. Doks removes unused css, prefetches links, and lazy loads images.'
 [[extra.list]]
 title = "SEO-ready"
 content = "Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking."
 [[extra.list]]
 title = "Full text search"
 content = "Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking."
 [[extra.list]]
 title = "Page layouts"
 content = "Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs."
 [[extra.list]]
 title = "Dark mode"
 content = "Switch to a low-light UI with the click of a button. Change colors with variables to match your branding."
 +++
--- a/content/authors/_index.md
+++ b/content/authors/_index.md
@ -0,0 +1,18 @@
 +++
 title = "Authors"
 description = "The authurs 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]
 "aaran-xu" = "authors/aaran-xu.md"
 +++
 The authors of the blog articles.
--- a/content/authors/aaran-xu.md
+++ b/content/authors/aaran-xu.md
@ -0,0 +1,11 @@
 +++
 title = "Aaran Xu"
 description = "Creator of AdiDoks."
 date = 2021-04-01T08:50:45+00:00
 updated = 2021-04-01T08:50:45+00:00
 draft = false
 +++
 Creator of **AdiDoks**.
 [@aaranxu](https://github.com/aaranxu)
--- a/content/blog/_index.md
+++ b/content/blog/_index.md
@ -0,0 +1,7 @@
 +++
 title = "Blog"
 description = "Blog"
 sort_by = "date"
 paginate_by = 2
 template = "blog/section.html"
 +++
--- a/content/blog/hello-world.md
+++ b/content/blog/hello-world.md
@ -0,0 +1,41 @@
 +++
 title = "Hello World"
 description = "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
 date = 2021-05-01T09:19:42+00:00
 updated = 2021-05-01T09:19:42+00:00
 draft = false
 template = "blog/page.html"
 [taxonomies]
 authors = ["Rustaceans"]
 [extra]
 lead = "This is the source code of the traditional <b>Hello World</b> program."
 +++
 ```rust
 // This is a comment, and is ignored by the compiler
 // This is the main function
 fn main() {
    // Statements here are executed when the compiled binary is called
    // Print text to the console
    println!("Hello World!");
 }
 ```
 `println!` is a macro that prints text to the console.
 A binary can be generated using the Rust compiler: `rustc`.
 ```bash
 $ rustc hello.rs
 ```
 `rustc` will produce a `hello` binary that can be executed.
 ```bash
 $ ./hello
 Hello World!
 ```
--- a/content/blog/markdown-syntax.md
+++ b/content/blog/markdown-syntax.md
@ -0,0 +1,152 @@
 +++
 title = "Markdown Syntax Guide"
 description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
 date = 2021-04-20T09:19:42+00:00
 updated = 2021-04-20T09:19:42+00:00
 draft = false
 template = "blog/page.html"
 [taxonomies]
 authors = ["Public"]
 [extra]
 lead = "This article offers a sample of basic Markdown syntax that can be used in Zola content files, also it shows whether basic HTML elements are decorated with CSS in a Zola theme."
 +++
 ## Headings
 The following HTML `<h1>`—`<h6>` elements represent six levels of section
 headings. `<h1>` is the highest section level while `<h6>` is the lowest.
 # H1
 ## H2
 ### H3
 #### H4
 ##### H5
 ###### H6
 ## Paragraph
 Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum,
 voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma
 dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as
 cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin
 porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur?
 Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit
 ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda
 veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore
 eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata
 tiustia prat.
 Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne
 sapicia is sinveli squiatum, core et que aut hariosam ex eat.
 ## Blockquotes
 The blockquote element represents content that is quoted from another source,
 optionally with a citation which must be within a `footer` or `cite` element,
 and optionally with in-line changes such as annotations and abbreviations.
 #### Blockquote without attribution
 > Tiam, ad mint andaepu dandae nostion secatur sequo quae.
 > **Note** that you can use *Markdown syntax* within a blockquote.
 #### Blockquote with attribution
 > Don't communicate by sharing memory, share memory by communicating.<br>
 > — <cite>Rob Pike[^1]</cite>
 > All men by nature desire to know.<br>
 > ― <cite>Aristotle[^2]</cite>
 ## Tables
 Tables aren't part of the core Markdown spec, but Zola supports them
 out-of-the-box.
   Name | Age
 --------|------
    Bob | 27
  Alice | 23
 #### Inline Markdown within tables
 | Italics   | Bold     | Code   |
 | --------  | -------- | ------ |
 | *italics* | **bold** | `code` |
 ## Code Blocks
 #### Code block with backticks
 ```html
 <!doctype html>
 <html lang="en">
 <head>
  <meta charset="utf-8">
  <title>Example HTML5 Document</title>
 </head>
 <body>
  <p>Test</p>
 </body>
 </html>
 ```
 #### Code block indented with four spaces
    <!doctype html>
    <html lang="en">
    <head>
      <meta charset="utf-8">
      <title>Example HTML5 Document</title>
    </head>
    <body>
      <p>Test</p>
    </body>
    </html>
 ## List Types
 #### Ordered List
 1. First item
 2. Second item
 3. Third item
 #### Unordered List
 - List item
 - Another item
 - And another item
 #### Nested list
 - Fruit
  - Apple
  - Orange
  - Banana
 - Dairy
  - Milk
  - Cheese
 ## Other Elements — abbr, sub, sup, kbd, mark
 <abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.
 H<sub>2</sub>O
 X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
 Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the
 session.
 Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and
 other small creatures.
 ---
 <!-- Note: There must be a blank line between every two lines of the footnote difinition.  -->
 [^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c)
 during Gopherfest, November 18, 2015.
 [^2]: The quote is the first sentence of Aristotle's [Metaphysics](http://classics.mit.edu/Aristotle/metaphysics.html).
--- a/content/blog/math-typesetting.md
+++ b/content/blog/math-typesetting.md
@ -0,0 +1,48 @@
 +++
 title = "Math Typesetting"
 description = "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
 date = 2021-04-08T09:19:42+00:00
 updated = 2021-04-08T09:19:42+00:00
 draft = false
 template = "blog/page.html"
 [taxonomies]
 authors = ["Public"]
 [extra]
 lead = "Mathematical notation in a project can be enabled by using third party JavaScript libraries."
 math = true
 +++
 In this example we will be using [KaTeX](https://katex.org/)
 - Create a macro under `/template/macros/math.html` with a macro named `math`.
 - Within this macro reference the [Auto-render Extension](https://katex.org/docs/autorender.html) or host these scripts locally.
 - Import the macro in your templates like so:  
 ```bash
 {% import 'macros/math.html' as macros %}
 {% if page.extra.math or section.extra.math or config.extra.math %}
 {{ macros::math() }}
 {% endif %}
 ```
 - To enable KaTex globally set the parameter `extra.math` to `true` in a project's configuration
 - To enable KaTex on a per page basis include the parameter `extra.math = true` in content files
 **Note:** 
 1. The MathJax library is the other optional choice, and you can set the parameter `extra.library` to `mathjax` in a project's configuration
 2. Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html)
 ### Examples
 <p>
 Inline math: \(\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…\) 
 </p>
 Block math:
 $$
 \varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } } 
 $$
--- a/content/blog/placeholder-text.md
+++ b/content/blog/placeholder-text.md
@ -0,0 +1,62 @@
 +++
 title = "Placeholder Text"
 description = "Lorem Ipsum Dolor Si Amet"
 date = 2021-04-10T09:19:42+00:00
 updated = 2021-04-10T09:19:42+00:00
 draft = false
 template = "blog/page.html"
 [taxonomies]
 authors = ["Public"]
 +++
 Lorem est tota propiore conpellat pectoribus de pectora summo. <!--more-->Redit
 teque digerit hominumque toris verebor lumina non cervice subde tollit usus
 habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus
 inhospita parcite confusaque translucet patri vestro qui optatis lumine
 cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.
 1. Exierant elisi ambit vivere dedere
 2. Duce pollice
 3. Eris modo
 4. Spargitque ferrea quos palude
 Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus
 silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.
 1. Comas hunc haec pietate fetum procerum dixit
 2. Post torum vates letum Tiresia
 3. Flumen querellas
 4. Arcanaque montibus omnes
 5. Quidem et
 # Vagus elidunt
 <svg class="canon" xmlns="http://www.w3.org/2000/svg" overflow="visible" viewBox="0 0 496 373" height="373" width="496"><g fill="none"><path stroke="#000" stroke-width=".75" d="M.599 372.348L495.263 1.206M.312.633l494.95 370.853M.312 372.633L247.643.92M248.502.92l246.76 370.566M330.828 123.869V1.134M330.396 1.134L165.104 124.515"></path><path stroke="#ED1C24" stroke-width=".75" d="M275.73 41.616h166.224v249.05H275.73zM54.478 41.616h166.225v249.052H54.478z"></path><path stroke="#000" stroke-width=".75" d="M.479.375h495v372h-495zM247.979.875v372"></path><ellipse cx="498.729" cy="177.625" rx=".75" ry="1.25"></ellipse><ellipse cx="247.229" cy="377.375" rx=".75" ry="1.25"></ellipse></g></svg>
 [The Van de Graaf Canon](https://en.wikipedia.org/wiki/Canons_of_page_construction#Van_de_Graaf_canon)
 ## Mane refeci capiebant unda mulcebat
 Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit
 colit est profanae esse virescere furit nec; iaculi matertera et visa est,
 viribus. Divesque creatis, tecta novat collumque vulnus est, parvas.
 **Faces illo pepulere** tempus adest. Tendit flamma, ab opes virum sustinet,
 sidus sequendo urbis.
 Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli
 Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare
 Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert
 ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae
 vulnus haerentia iuste et exercebat, sui et.
 Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit
 sequitur. Vel **mitis temploque** vocatus, inque alis, *oculos nomen* non silvis
 corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti
 flumina mortis facto sic: undique a alios vincula sunt iactata abdita!
 Suspenderat ego fuit tendit: luna, ante urbem Propoetides **parte**.
 <style>
 .canon { background: white; width: 100%; height: auto; }
 </style>
--- a/content/blog/say-hello-to-zola-doks.md
+++ b/content/blog/say-hello-to-zola-doks.md
@ -0,0 +1,15 @@
 +++
 title = "Say hello to AdiDoks 👋"
 description = "Introducing AdiDoks, a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola."
 date = 2021-04-03T07:00:00+00:00
 updated = 2021-04-03T07:00:00+00:00
 template = "blog/page.html"
 draft = false
 [taxonomies]
 authors = ["Aaran Xu"]
 [extra]
 lead = 'Introducing AdiDoks, 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.'
 images = []
 +++
--- a/content/docs/_index.md
+++ b/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"
 +++
--- a/content/docs/contributing/_index.md
+++ b/content/docs/contributing/_index.md
@ -0,0 +1,10 @@
 +++
 title = "Contributing"
 description = "Find out how to contribute to AdiDoks."
 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
 +++
--- a/content/docs/contributing/code-of-conduct.md
+++ b/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
--- a/content/docs/contributing/how-to-contribute.md
+++ b/content/docs/contributing/how-to-contribute.md
@ -0,0 +1,37 @@
 +++
 title = "How to Contribute"
 description = "Contribute to AdiDoks, 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 AdiDoks, 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 AdiDoks code lives in the [`adidoks` repository](https://github.com/aaranxu/adidoks)
 - 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/)
--- a/content/docs/getting-started/_index.md
+++ b/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
 +++
--- a/content/docs/getting-started/introduction.md
+++ b/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/)
--- a/content/docs/getting-started/quick-start.md
+++ b/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.
--- a/content/docs/help/_index.md
+++ b/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
 +++
--- a/content/docs/help/faq.md
+++ b/content/docs/help/faq.md
@ -0,0 +1,39 @@
 +++
 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
 +++
 ## What is the AdiDoks?
 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).
 ## 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/)
 ## Contact the creator?
 Send *Aaran Xu* an E-mail:
 - <aaranxu@outlook.com>
--- a/content/privacy-policy/_index.md
+++ b/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](https://github.com/aaranxu/adidoks) if you have any questions.
 Effective Date: _1st May 2021_
--- a/themes/adidoks
+++ b/themes/adidoks
@ -0,0 +1 @@
 Subproject commit 5c698271c460046034605b743a15196b12e32887
		`@ -0,0 +1 @@`
							`Subproject commit 5c698271c460046034605b743a15196b12e32887`