Skip to content

Commit d7c2084

Browse files
committed
Add Giscus comments integration and update MkDocs configuration
- Introduced a new .markdownlint.json file to manage markdown linting rules. - Updated mkdocs.yml to enhance theme features and added offline plugin for improved performance. - Added new JavaScript files for Giscus comments functionality, including client and debug scripts. - Created a new comments partial to integrate Giscus comments into the documentation. - Removed outdated footer.html to streamline the comments integration process.
1 parent 7d43efb commit d7c2084

File tree

12 files changed

+126
-74
lines changed

12 files changed

+126
-74
lines changed

.github/workflows/deploy_to_pages.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ jobs:
2727
- name: 📦 Cache dependencies
2828
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
2929

30-
- uses: actions/cache@v4
30+
- name: 📦 Cache Keys
31+
uses: actions/cache@v4
3132
with:
3233
key: mkdocs-material-${{ env.cache_id }}
3334
path: .cache

.markdownlint.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"default": true,
3+
"MD013": false
4+
}
5+

docs/.meta.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
comments: true

docs/overrides/partials/footer.html

Lines changed: 0 additions & 24 deletions
This file was deleted.

mkdocs.yml

Lines changed: 48 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,30 @@ site_name: System Design Primer Update
22
site_url: https://ido777.github.io/system-design-primer-update/en/study_guide/
33

44
repo_url: https://github.com/ido777/system-design-primer-update
5+
repo_name: ido777/system-design-primer-update
56

6-
use_directory_urls: true
7+
# use_directory_urls: true
78

89
theme:
910
name: material
1011
language: en
1112
custom_dir: overrides/
1213
features:
13-
- content.code.annotate
14-
- content.tabs.link
15-
- navigation.sections
1614
- navigation.tabs
15+
- navigation.tabs.sticky
1716
- navigation.top
1817
- navigation.footer
18+
- navigation.indexes
19+
- navigation.instant
20+
- navigation.instant.prefetch
21+
- navigation.instant.progress
22+
- navigation.tracking
23+
- navigation.path
24+
- content.code.annotate
25+
- content.tabs.link
1926
- search.highlight
2027
- search.suggest
28+
- toc.follow
2129
palette:
2230
- media: "(prefers-color-scheme: light)"
2331
scheme: default
@@ -31,22 +39,22 @@ theme:
3139
name: Switch to light mode
3240

3341
plugins:
34-
- i18n:
35-
default_language: en
36-
languages:
37-
- locale: en
38-
name: English
39-
default: true
40-
- locale: zh
41-
name: Simplified Chinese
42-
- locale: zh-Hant
43-
name: Traditional Chinese
44-
- locale: ja
45-
name: Japanese
46-
- locale: tr
47-
name: Turkish
48-
- locale: ar
49-
name: Arabic
42+
# - i18n:
43+
# default_language: en
44+
# languages:
45+
# - locale: en
46+
# name: English
47+
# default: true
48+
# - locale: zh
49+
# name: Simplified Chinese
50+
# - locale: zh-Hant
51+
# name: Traditional Chinese
52+
# - locale: ja
53+
# name: Japanese
54+
# - locale: tr
55+
# name: Turkish
56+
# - locale: ar
57+
# name: Arabic
5058
- search # MkDocs default search plugin
5159
- git-revision-date-localized:
5260
type: date # or datetime, iso_date, iso_datetime, timeago
@@ -58,6 +66,7 @@ plugins:
5866
repository: ido777/system-design-primer-update
5967
branch: main
6068
- meta
69+
- offline
6170
# - htmlproofer
6271

6372
extra:
@@ -76,10 +85,27 @@ extra:
7685
theme: light
7786
lang: en
7887
loading: lazy
88+
# alternate:
89+
# - name: English
90+
# link: en/index.md
91+
# lang: en
92+
# - name: 简体中文
93+
# link: /zh/
94+
# lang: zh
95+
# - name: 繁體中文
96+
# link: /zh-Hant/
97+
# lang: zh-Hant
98+
# - name: 日本語
99+
# link: /ja/
100+
# lang: ja
79101

80102
extra_javascript:
81-
- js/client-debug.js
82-
- js/giscus-debug.js
103+
- javascripts/client-debug.js
104+
- javascripts/giscus-debug.js
105+
106+
extra_css:
107+
- stylesheets/default.css
108+
83109

84110
markdown_extensions:
85111
- admonition

0 commit comments

Comments
 (0)