Skip to content

Commit ee96c49

Browse files
committed
Enhance mkdocs configuration and documentation structure: add new markdown extensions, update navigation links to README files for object-oriented design solutions, and create individual README files for each solution.
1 parent b91fd46 commit ee96c49

File tree

9 files changed

+131
-9
lines changed

9 files changed

+131
-9
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Call Center Code
2+
3+
4+
``` py title="call_center.py"
5+
--8<-- "./call_center.py"
6+
```
7+
8+
9+
10+
``` py title="call_center.ipynb"
11+
--8<-- "./call_center.ipynb"
12+
```
13+
14+
15+
16+
``` py title="./tests/test_call_center.py"
17+
--8<-- "./tests/test_call_center.py"
18+
```
19+
20+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Circular Array Code
2+
3+
4+
``` py title="circular_array.py"
5+
--8<-- "./circular_array.py"
6+
```
7+
8+
9+
10+
``` py title="circular_array.ipynb"
11+
--8<-- "./circular_array.ipynb"
12+
```
13+
14+
15+
16+
17+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Deck of Cards
2+
3+
4+
``` py title="deck_of_cards.py"
5+
--8<-- "./deck_of_cards.py"
6+
```
7+
8+
9+
10+
``` py title="deck_of_cards.ipynb"
11+
--8<-- "./deck_of_cards.ipynb"
12+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Hash Table Implementation
2+
3+
``` py title="hash_map.py"
4+
--8<-- "./hash_map.py"
5+
```
6+
7+
8+
9+
``` py title="hash_map.ipynb"
10+
--8<-- "./hash_map.ipynb"
11+
```
12+
13+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# LRU Cache Implementation
2+
3+
4+
``` py title="lru_cache.py"
5+
--8<-- "./lru_cache.py"
6+
```
7+
8+
9+
10+
``` py title="lru_cache.ipynb"
11+
--8<-- "./lru_cache.ipynb"
12+
```
13+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
1+
# Movie Tickets Kiosk System
2+
13
Movie tickets kiosk system OOP example in Java
4+
25
- Jeremy Hu 09/2022
6+
7+
``` java title="MovieTickets.java"
8+
--8<-- "./MovieTickets.java"
9+
```
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Online Chat Implementation
2+
3+
4+
``` py title="online_chat.py"
5+
--8<-- "./online_chat.py"
6+
```
7+
8+
9+
10+
``` py title="online_chat.ipynb"
11+
--8<-- "./online_chat.ipynb"
12+
```
13+
14+
15+
16+
17+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Parking Lot Implementation
2+
3+
4+
``` py title="parking_lot.py"
5+
--8<-- "./parking_lot.py"
6+
```
7+
8+
9+
10+
``` py title="parking_lot.ipynb"
11+
--8<-- "./parking_lot.ipynb"
12+
```

mkdocs.yml

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ theme:
2222
- navigation.tracking
2323
- navigation.path
2424
- content.code.annotate
25+
- content.code.copy
2526
- content.tabs.link
2627
- search.highlight
2728
- search.suggest
@@ -116,18 +117,28 @@ extra_css:
116117

117118
markdown_extensions:
118119
- admonition
119-
- pymdownx.snippets
120+
- pymdownx.snippets:
121+
base_path: [docs, docs/en, docs/solutions/object_oriented_design/call_center, docs/solutions/object_oriented_design/circular_array, docs/solutions/object_oriented_design/deck_of_cards, docs/solutions/object_oriented_design/hash_table, docs/solutions/object_oriented_design/lru_cache, docs/solutions/object_oriented_design/movie_tickets, docs/solutions/object_oriented_design/online_chat, docs/solutions/object_oriented_design/parking_lot]
122+
- pymdownx.highlight:
123+
anchor_linenums: true
124+
use_pygments: true
125+
auto_title: true
126+
linenums: true
127+
line_spans: __span
128+
pygments_lang_class: true
129+
- pymdownx.inlinehilite
120130
- pymdownx.superfences:
121131
custom_fences:
122132
- name: mermaid
123133
class: mermaid
124134
format: !!python/name:pymdownx.superfences.fence_code_format
125135
- pymdownx.details
126-
- pymdownx.highlight
127136
- pymdownx.emoji
128137
- pymdownx.mark
129138
- pymdownx.tabbed
130139
- pymdownx.tasklist
140+
- pymdownx.keys
141+
- pymdownx.smartsymbols
131142
- toc:
132143
permalink: true
133144

@@ -176,13 +187,13 @@ nav:
176187
- Twitter: solutions/system_design/twitter/README.md
177188
- Object-Oriented Design Solutions:
178189
- Call Center: solutions/object_oriented_design/call_center/README.md
179-
- Circular Array: solutions/object_oriented_design/circular_array/circular_array.py
180-
- Deck of Cards: solutions/object_oriented_design/deck_of_cards/deck_of_cards.py
181-
- Hash Table: solutions/object_oriented_design/hash_table/hash_table.py
182-
- LRU Cache: solutions/object_oriented_design/lru_cache/lru_cache.py
183-
- Movie Tickets: solutions/object_oriented_design/movie_tickets/movie_tickets.py
184-
- Online Chat: solutions/object_oriented_design/online_chat/online_chat.py
185-
- Parking Lot: solutions/object_oriented_design/parking_lot/parking_lot.py
190+
- Circular Array: solutions/object_oriented_design/circular_array/README.md
191+
- Deck of Cards: solutions/object_oriented_design/deck_of_cards/README.md
192+
- Hash Table: solutions/object_oriented_design/hash_table/README.md
193+
- LRU Cache: solutions/object_oriented_design/lru_cache/README.md
194+
- Movie Tickets: solutions/object_oriented_design/movie_tickets/README.md
195+
- Online Chat: solutions/object_oriented_design/online_chat/README.md
196+
- Parking Lot: solutions/object_oriented_design/parking_lot/README.md
186197
- WIP (old structure and content, will be removed):
187198
- Original System Design Primer as one page (WIP): en/design-glance.md
188199
- 'Motivation': en/sd_motivation.md

0 commit comments

Comments
 (0)