Repository navigation
Conversation
The `---` line directly after the LangChain badge paragraph turned the badges into an h2 heading (setext syntax) instead of a horizontal rule. Docsify v5 lists that heading in the sidebar as an empty entry. Add a blank line so it renders as a separator, matching the other sections of the list.
The unpinned CDN path `docsify/lib/docsify.min.js` now serves the legacy v4.13.1 build, which logs "Docsify v4 is no longer supported" on every page load. - Pin `docsify@5` and load it from the `dist/` path - Replace docsify-themeable with the v5 core theme and its dark mode add-on; docsify-themeable does not support the v5 sidebar toggle, which breaks navigation on mobile - Use explicit https URLs for the CDN assets See https://docsify.js.org/#/v5-upgrade
This branch has not been deployed
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.
Summary
The docs site at https://microsoft.github.io/AI-For-Beginners/ still runs Docsify v4 and logs
Docsify v4 is no longer supportedon every page load.index.htmlloadsdocsify/lib/docsify.min.jswithout a version, so jsDelivr serves the newest package (5.0.0). Inside that package, however,lib/only contains the legacy v4.13.1 build, kept for backwards compatibility. The actual v5 build is indist/. This PR switches todocsify@5/dist/docsify.min.js, so the site runs v5 (Docsify.versionreturns5.0.0).Changes
index.html: upgrade to Docsify v5 following the official upgrade guidedocsify@5and load it fromdist/docsify-themeablewith the v5 core theme and its dark mode add-onsidebar-chevron-rightbody classhttpsURLs for the CDN assetsREADME.md: add a blank line before the---after the LangChain badges. Without it, the badges parse as a setexth2heading instead of a paragraph followed by a horizontal rule. Docsify v5 lists that heading as an empty sidebar entry, and GitHub renders it as a heading as well.Why replace docsify-themeable
docsify-themeablewas last released in 2022 (0.9.0) and only supports Docsify v4. In v5 the sidebar toggle sets ashowclass on.sidebarinstead ofcloseon<body>, so with themeable the toggle does nothing. On mobile, where the sidebar is hidden by default, that leaves no way to open the navigation. The v5 core theme is the replacement the upgrade guide recommends.Testing
I rendered the new
index.htmlagainst the live site content in Chromium:prefers-color-schemeNotes for reviewers
theme-simple.?id=) now follow GitHub's slug rules: emoji are dropped and separators are kept. For example,?id=🌐-multi-language-supportbecomes?id=-multi-language-support, and?id=artificial-intelligence-for-beginners-a-curriculumbecomes?id=artificial-intelligence-for-beginners---a-curriculum. This affects 87 anchors on 31 pages. I compared v4 and v5 on all 68 non-translation pages: links within the site still resolve. Old external links to these sections still open the right page, but no longer scroll to the section.CO-OP TRANSLATOR OTHER COURSESmarkers. If Co-op Translator regenerates that block, the blank line may need to go into its template.Permissions-Policyheader, so the "Unrecognized feature" errors come from the browser. Theunloadviolations come from browser extension content scripts.