Skip to content

Commit 05b3fd9

Browse files
muratbiberoglumuratbiberoglu
authored
Merge pull request #80 from inzva/site-init
initial version of mkdocs site
2 parents 2f006fd + 777146c commit 05b3fd9

File tree

9 files changed

+172
-0
lines changed

9 files changed

+172
-0
lines changed

‎.github/workflows/ci.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- master
6+
permissions:
7+
contents: write
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- name: Configure Git Credentials
14+
run: |
15+
git config user.name github-actions[bot]
16+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
17+
- uses: actions/setup-python@v5
18+
with:
19+
python-version: 3.x
20+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
21+
- uses: actions/cache@v4
22+
with:
23+
key: mkdocs-material-${{ env.cache_id }}
24+
path: .cache
25+
restore-keys: |
26+
mkdocs-material-
27+
- run: pip install mkdocs-material
28+
- run: mkdocs gh-deploy --force

‎docs/dynamic-programming/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Dynamic Programming
3+
tags:
4+
- "Dynamic Programming"
5+
---

‎docs/index.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Algorithm Program
3+
---
4+
5+
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.
6+
7+
There is also a video playlist in Turkish about some of the algorithms and data structures in YouTube:
8+
9+
<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>
10+
11+
## How to Use This Site
12+
13+
- 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.
14+
- In each lecture related problems and training sets from [algoleague.com](https://algoleague.com) are mentioned. Practicing those is highly recommended.
15+
16+
## How to Contribute
17+
18+
In order to contribute (adding new lecture, fixing any type of errors) below steps should be followed:
19+
20+
1. Create an issue and briefly explain the purpose of your contribution.
21+
2. Fork the repository with your personal account and apply your changes.
22+
3. Create a pull request to master branch and add the link of pull request to issue.
23+
4. After reviewing your pull request and discussion, your pull request will be merged. Thank you for your contribution!

‎docs/introduction/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Introduction
3+
---

‎docs/overrides/partials/content.html

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Title and Level -->
2+
<h1 style="display: inline;">
3+
{% if page.meta.title %} <!-- if meta has title use it -->
4+
{{ page.meta.title }}
5+
{% else %} <!-- else use filename -->
6+
{{ page.title }}
7+
{% endif %}
8+
</h1>
9+
10+
<hr>
11+
12+
<!-- Page content -->
13+
{{ page.content }}
14+
15+
<!-- Editors and Reviewers -->
16+
{% if page.meta.editors|length or page.meta.reviewers|length %}
17+
<hr>
18+
{% if page.meta.editors|length %}
19+
<p><strong>Editors: </strong>{{page.meta.editors|join(", ")}}</p>
20+
{% endif %}
21+
{% if page.meta.reviewers|length %}
22+
<p><strong>Reviewers: </strong>{{page.meta.reviewers|join(", ")}}</p>
23+
{% endif %}
24+
{% endif %}

‎docs/static/img/favicon.png

11.4 KB
Loading

‎docs/static/img/logo.png

25.1 KB
Loading

‎docs/static/javascripts/katex.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
document$.subscribe(({ body }) => {
2+
renderMathInElement(body, {
3+
delimiters: [
4+
{ left: "$$", right: "$$", display: true },
5+
{ left: "$", right: "$", display: false },
6+
{ left: "\\(", right: "\\)", display: false },
7+
{ left: "\\[", right: "\\]", display: true }
8+
],
9+
})
10+
})

‎mkdocs.yml

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
site_name: Algorithm Program
2+
site_url: https://inzva.github.io/Algorithm-Program/
3+
nav:
4+
- Home: index.md
5+
- Introduction: introduction/index.md
6+
- Dynamic Programming: dynamic-programming/index.md
7+
theme:
8+
name: material
9+
custom_dir: docs/overrides
10+
favicon: static/img/favicon.png
11+
logo: static/img/logo.png
12+
features:
13+
- toc.follow
14+
- navigation.tabs
15+
- navigation.sections
16+
- toc.integrate
17+
- navigation.top
18+
- search.suggest
19+
- search.highlight
20+
- content.tabs.link
21+
- content.code.annotation
22+
- content.code.copy
23+
language: en
24+
palette:
25+
- scheme: default
26+
toggle:
27+
icon: material/weather-night
28+
name: Switch to dark mode
29+
primary: black
30+
accent: grey
31+
- scheme: slate
32+
toggle:
33+
icon: material/weather-sunny
34+
name: Switch to light mode
35+
primary: black
36+
accent: purple
37+
38+
extra:
39+
social:
40+
- icon: fontawesome/brands/github-alt
41+
link: https://github.com/inzva
42+
- icon: fontawesome/brands/twitter
43+
link: https://twitter.com/inzvaspace
44+
- icon: fontawesome/brands/instagram
45+
link: https://instagram.com/inzva.space/
46+
- icon: fontawesome/brands/linkedin
47+
link: https://linkedin.com/company/inzva/
48+
49+
extra_javascript:
50+
- static/javascripts/katex.js
51+
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
52+
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
53+
54+
extra_css:
55+
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
56+
57+
markdown_extensions:
58+
- pymdownx.highlight:
59+
anchor_linenums: true
60+
- pymdownx.inlinehilite
61+
- pymdownx.snippets
62+
- admonition
63+
- pymdownx.arithmatex:
64+
generic: true
65+
- footnotes
66+
- pymdownx.details
67+
- pymdownx.superfences
68+
- pymdownx.mark
69+
- attr_list
70+
- pymdownx.emoji:
71+
emoji_index: !!python/name:material.extensions.emoji.twemoji
72+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
73+
74+
plugins:
75+
- search
76+
- tags
77+
78+
copyright: |
79+
&copy; 2024 <a href="https://inzva.com/" target="_blank" rel="noopener">inzva</a>

0 commit comments

Comments
 (0)