Skip to content

Commit 6bc04b2

Browse files
authored
Refactor MkDocs configuration to improve navigation (#536)
* 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. * Add .meta.yml files for solutions and resources to enable comments functionality * Enable directory URLs in MkDocs configuration for cleaner navigation * Refactor MkDocs configuration to improve navigation and add new documentation files - Updated navigation paths in mkdocs.yml to point to local documentation files for About, Contributing, License, and Changelog. - Commented out the offline plugin for potential future use. - Added new symbolic links for About, Contributing, License, and Changelog documents in the docs directory.
1 parent d7c2084 commit 6bc04b2

File tree

7 files changed

+10
-4
lines changed

7 files changed

+10
-4
lines changed

docs/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CHANGELOG.md

docs/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CONTRIBUTING.md

docs/LICENSE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../LICENSE.md

docs/about.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

docs/solutions/.meta.yml

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

mkdocs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,10 @@ markdown_extensions:
125125

126126
nav:
127127
- Home: en/index.md
128-
- About: https://github.com/ido777/system-design-primer-update/blob/main/README.md
129-
- Contributing: https://github.com/ido777/system-design-primer-update/blob/main/CONTRIBUTING.md
130-
- License: https://github.com/ido777/system-design-primer-update/blob/main/LICENSE.md
131-
- Changelog: https://github.com/ido777/system-design-primer-update/blob/main/CHANGELOG.md
128+
- About: about.md
129+
- Contributing: CONTRIBUTING.md
130+
- License: LICENSE.md
131+
- Changelog: CHANGELOG.md
132132
- English:
133133
- Overview: en/index.md
134134
- Study Guide Start Here: en/study_guide.md

resources/.meta.yml

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

0 commit comments

Comments
 (0)