Add dev server functionality based on docsify#9347
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Docsify-based local preview workflow for this docs repo, intended to help contributors browse content locally with navigation/search and validate links.
Changes:
- Add Docsify dev server (
npm run serve) and dependency ondocsify-cli. - Add a generated multi-section sidebar workflow (
build/generate-sidebar.js) and supporting navbar/landing READMEs. - Ignore generated sidebar files in
.gitignore.
Reviewed changes
Copilot reviewed 7 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
package.json |
Adds generate-sidebar and serve scripts; adds docsify-cli dev dependency. |
package-lock.json |
Locks the new docsify-cli dependency tree. |
index.html |
Introduces the Docsify app shell/config, including sidebar/navbar config, search, and custom plugins. |
build/generate-sidebar.js |
Generates _sidebar*.md files from existing TOC JSON and frontmatter metadata. |
_navbar.md |
Adds top-level navbar links for Docs/API/Blogs/Release Notes. |
blogs/README.md |
Adds a landing page for the /blogs/ route. |
release-notes/README.md |
Adds a landing page for the /release-notes/ route. |
CONTRIBUTING.md |
Documents how to run the local Docsify preview. |
.gitignore |
Ignores generated sidebar markdown files. |
.nojekyll |
Adds .nojekyll marker file (empty). |
Comments suppressed due to low confidence (2)
index.html:221
- Docsify scripts are loaded from jsDelivr using unpinned versions ("docsify@4") and without subresource integrity. For reproducibility/supply-chain safety, prefer pinning exact versions and adding integrity/crossorigin (or vendoring locally).
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
</body>
index.html:135
- The folder toggle click handler always calls preventDefault(). If the toggle element is an anchor, this will block normal navigation. Consider only preventing default for non-anchor toggles, or checking for an href before preventing navigation.
toggle.addEventListener('click', function (e) {
e.preventDefault();
e.stopPropagation();
this.parentElement.classList.toggle('open');
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
Author
|
@rzhao271 Added support for hosting the vscode-docs locally for contributors. It's not full fidelity but enables reviewing content without access to the website infra project. |
rzhao271
approved these changes
Feb 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a local documentation preview workflow using Docsify. The changes make it easier for contributors to preview and navigate the documentation site locally.
The website does not exactly match the production website in terms of style, but enables previewing content changes and verifying cross-linking.
To preview docs locally, run the following command in the terminal: