Merge pull request #80 from inzva/site-init

initial version of mkdocs site

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

docs/dynamic-programming/index.md

@@ -0,0 +1,5 @@
+---
+title: Dynamic Programming
+tags:
+    - "Dynamic Programming"
+---

docs/index.md

@@ -0,0 +1,23 @@
+---
+title: Algorithm Program
+---
+
+Algoritm Program contains lectures about algorithms and data structures which are prepared by inzva community, aimed at teaching advanced knowledge of algorithms to university students, spreading algorithmic thinking and providing training which will help them in international contests as well as in their professional lives.
+
+There is also a video playlist in Turkish about some of the algorithms and data structures in YouTube:
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?si=BKn_0tDSobEresKb&amp;list=PLhnxo6HZwBgkNxS6HxkyGg4W5RIJNh9Is" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+
+## How to Use This Site
+
+- Lectures can be found by topics at the navigation bar. The sub topics can be found at those pages. Search bar is also available for finding pages by terms.
+- In each lecture related problems and training sets from [algoleague.com](https://algoleague.com) are mentioned. Practicing those is highly recommended.
+
+## How to Contribute
+
+In order to contribute (adding new lecture, fixing any type of errors) below steps should be followed:
+
+1. Create an issue and briefly explain the purpose of your contribution.
+2. Fork the repository with your personal account and apply your changes.
+3. Create a pull request to master branch and add the link of pull request to issue.
+4. After reviewing your pull request and discussion, your pull request will be merged. Thank you for your contribution!

docs/introduction/index.md

@@ -0,0 +1,3 @@
+---
+title: Introduction
+---

docs/overrides/partials/content.html

@@ -0,0 +1,24 @@
+<!-- Title and Level -->
+<h1 style="display: inline;">
+    {% if page.meta.title %}    <!-- if meta has title use it -->
+        {{ page.meta.title }}
+    {% else %}                  <!-- else use filename -->
+        {{ page.title }}
+    {% endif %}
+</h1>
+
+<hr>
+
+<!-- Page content -->
+{{ page.content }}
+
+<!-- Editors and Reviewers -->
+{% if page.meta.editors|length or page.meta.reviewers|length %}
+    <hr>
+    {% if page.meta.editors|length %}
+        <p><strong>Editors: </strong>{{page.meta.editors|join(", ")}}</p>
+    {% endif %}
+    {% if page.meta.reviewers|length %}
+        <p><strong>Reviewers: </strong>{{page.meta.reviewers|join(", ")}}</p>
+    {% endif %}
+{% endif %}

docs/static/javascripts/katex.js

@@ -0,0 +1,10 @@
+document$.subscribe(({ body }) => {
+    renderMathInElement(body, {
+        delimiters: [
+            { left: "$$", right: "$$", display: true },
+            { left: "$", right: "$", display: false },
+            { left: "\\(", right: "\\)", display: false },
+            { left: "\\[", right: "\\]", display: true }
+        ],
+    })
+})

mkdocs.yml

@@ -0,0 +1,79 @@
+site_name: Algorithm Program
+site_url: https://inzva.github.io/Algorithm-Program/
+nav:
+  - Home: index.md
+  - Introduction: introduction/index.md
+  - Dynamic Programming: dynamic-programming/index.md
+theme:
+  name: material
+  custom_dir: docs/overrides
+  favicon: static/img/favicon.png
+  logo: static/img/logo.png
+  features:
+    - toc.follow
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.annotation
+    - content.code.copy
+  language: en
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+      primary: black
+      accent: grey
+    - scheme: slate
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+      primary: black
+      accent: purple
+
+extra:
+  social:
+    - icon: fontawesome/brands/github-alt
+      link: https://github.com/inzva
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/inzvaspace
+    - icon: fontawesome/brands/instagram
+      link: https://instagram.com/inzva.space/
+    - icon: fontawesome/brands/linkedin
+      link: https://linkedin.com/company/inzva/
+
+extra_javascript:
+  - static/javascripts/katex.js
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
+
+extra_css:
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - admonition
+  - pymdownx.arithmatex:
+      generic: true
+  - footnotes
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.mark
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+
+plugins:
+  - search
+  - tags
+
+copyright: |
+  &copy; 2024 <a href="https://inzva.com/" target="_blank" rel="noopener">inzva</a>