chore(docs): integrate a Zola theme (#22)

.codacy.yml

@@ -0,0 +1,10 @@
+engines:
+  go:
+    enabled: true
+tools:
+  golangci-lint:
+    enabled: true
+    configurations:
+      config: '.golangci.yml'
+exclude_paths:
+  - 'docs/themes/**/*'

.codeclimate.yml

@@ -22,3 +22,4 @@ exclude_paths:
   - '**/*_test.go'
   - '*_test.go'
   - 'vendor/'
+  - 'docs/themes/adidoks/'

.github/workflows/github-ci.yml

@@ -33,7 +33,9 @@ jobs:
       - name: Check Markdown format
         uses: DavidAnson/[email protected]
         with:
-          globs: '**/*.md'
+          globs: |
+            **/*.md
+            #docs/themes/adidoks/**/*.md
 
   audit:
     runs-on: ubuntu-latest

Makefile

@@ -25,7 +25,7 @@ req:			## Install requirements
 .PHONY: fmt
 fmt:			## Format the codebase
 	@goimports -e -w -local ${LOCAL_PKG} ${CURDIR}
-	@docker run --rm -v $(shell pwd):/workdir -t davidanson/markdownlint-cli2 '/workdir/**/*.md' --fix
+	@docker run --rm -v $(shell pwd):/workdir -t davidanson/markdownlint-cli2 '/workdir/**/*.md' '#/workdir/docs/themes/adidoks/**/*.md' --fix
 
 .PHONY: lint
 lint:			## Run static code analyzers

README.md

@@ -11,9 +11,9 @@
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Farttet%2FInterview-Preparation-Kit-in-Go.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Farttet%2FInterview-Preparation-Kit-in-Go?ref=badge_shield)
 [![GitHub License](https://img.shields.io/github/license/arttet/Interview-Preparation-Kit-in-Go)](LICENSE)
 
-The **Interview Preparation Kit in Go** consists of curated course modules I've
-completed across various learning platforms, aiming to assist developers in
-mastering algorithms and problem-solving techniques for technical interviews.
+The **Interview Preparation Kit in Go** is a collection of algorithm challenges
+and solutions from various courses, designed to assist developers prepare for
+technical interviews by mastering algorithms and problem-solving techniques.
 
 ## Usage
 

docs/config.toml

@@ -1,9 +1,20 @@
 # The URL the site will be built for
-base_url = "https://example.com"
+base_url = "https://arttet.github.io/Interview-Preparation-Kit-in-Go/"
+title = "The Interview Preparation Kit in Go"
+description = "The Interview Preparation Kit in Go"
+
+# The site theme to use.
+theme = "adidoks"
+
+# The default language; used in feeds and search index
+default_language = "en"
 
 # Whether to automatically compile all Sass files in the sass directory
 compile_sass = true
 
+# When set to "true", the generated HTML files are minified.
+minify_html = true
+
 # Whether to build a search index to be used later on by a JavaScript library
 build_search_index = true
 
@@ -13,4 +24,14 @@ build_search_index = true
 highlight_code = true
 
 [extra]
-# Put all your custom variables here
+timezone = "Asia/Dubai"
+
+[[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/arttet/Interview-Preparation-Kit-in-Go/"
+post = "v0.1.0"
+weight = 20
+
+[extra.footer]
+info = '© 2024 <a href="https://github.com/arttet">Artyom Tetyukhin</a>'

docs/content/_index.md

@@ -0,0 +1,20 @@
++++
+title = "The Interview Preparation Kit in Go"
+
+# The homepage contents
+[extra]
+lead = '<b>The Interview Preparation Kit in Go</b> is a collection of algorithm challenges and solutions from various courses, designed to assist developers prepare for technical interviews by mastering algorithms and problem-solving techniques.'
+url = "/docs/getting-started/introduction/"
+url_button = "Get started"
+repo_version = ""
+repo_license = "Apache 2.0 License"
+repo_url = "https://github.com/arttet/Interview-Preparation-Kit-in-Go"
+
+# Menu items
+[[extra.menu.main]]
+name = "Documentation"
+section = "docs"
+url = "/docs/getting-started/introduction/"
+weight = 10
+
++++

docs/content/docs/_index.md

@@ -0,0 +1,6 @@
++++
+title = "Documentation"
+sort_by = "weight"
+weight = 1
+template = "docs/section.html"
++++

docs/content/docs/getting-started/_index.md

@@ -0,0 +1,7 @@
++++
+title = "Getting Started"
+template = "docs/section.html"
+sort_by = "weight"
+weight = 1
+draft = false
++++

docs/content/docs/getting-started/introduction.md

@@ -0,0 +1,26 @@
++++
+title = "Introduction"
+draft = false
+weight = 10
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+lead = ''
+toc = true
+top = false
++++
+
+## Quick Start
+
+### Documentation in Progress
+
+Thank you for visiting this website. Please note that the documentation is
+currently under development. I am actively working on providing comprehensive
+and detailed information about the configuration files and scripts included in
+this repository.
+
+In the meantime, feel free to explore the repository and reach out if you have
+any questions. Your patience and understanding are greatly appreciated.
+
+Stay tuned for updates!

docs/themes/adidoks/sass/_custom.scss

@@ -0,0 +1,3 @@
+.navbar {
+    background-color: rgba(106, 215, 229, 255);
+}

docs/themes/adidoks/sass/bootstrap/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2011-2021 Twitter, Inc.
+Copyright (c) 2011-2021 The Bootstrap Authors
+
+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.