feat: migrate docs to mdBook, add cross-platform support, and publish 17 module pages - #4
Merged
Merged
Conversation
…prehensive module pages
…l and SSH modules
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.
Overview
This PR is a major documentation and cross-platform overhaul of Aliaskit, covering three key areas: a full migration from Jekyll to mdBook, comprehensive per-module documentation across all 17 modules, and native cross-platform compatibility for Linux, macOS, and WSL/Windows.
🗂️ Documentation: Jekyll → mdBook Migration
Replaced the GitHub Pages Jekyll configuration with a proper mdBook static site, using the
mdbook-templatepreprocessor for dynamic module footers.New files:
book.toml— mdBook project config pointing todocs/src/docs/src/SUMMARY.md— Sidebar navigation for all 17 module chapters + Contributing guidedocs/src/templates/footer.md— Reusable footer injected into every module page via{{#template}}.github/workflows/mdbook.yml— CI/CD that auto-downloadsmdbook+mdbook-templatebinaries and deploys to GitHub Pages on every push tomain📚 Documentation: 17 Comprehensive Module Pages
Every module now has its own dedicated chapter in
docs/src/modules/, each containing:mdbook-templateModules documented:
navigation,files,system,process,packages,network,git,docker,python,node,dotnet,cpp_java,archives,editors,servers,ssh,productivity🌐 Cross-Platform Support
Aliaskit now officially supports Linux, macOS, and WSL/Windows with targeted fixes rather than a full rewrite.
core/init.sh— OS DetectionAdded
$AK_OSenvironment variable exported at load time: