Skip to content

feat: migrate docs to mdBook, add cross-platform support, and publish 17 module pages - #4

Merged
maruf-pfc merged 5 commits into
blackstart-labs:mainfrom
maruf-pfc:main
Apr 5, 2026
Merged

feat: migrate docs to mdBook, add cross-platform support, and publish 17 module pages#4
maruf-pfc merged 5 commits into
blackstart-labs:mainfrom
maruf-pfc:main

Conversation

@maruf-pfc

Copy link
Copy Markdown
Contributor

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-template preprocessor for dynamic module footers.

New files:

  • book.toml — mdBook project config pointing to docs/src/
  • docs/src/SUMMARY.md — Sidebar navigation for all 17 module chapters + Contributing guide
  • docs/src/templates/footer.md — Reusable footer injected into every module page via {{#template}}
  • .github/workflows/mdbook.yml — CI/CD that auto-downloads mdbook + mdbook-template binaries and deploys to GitHub Pages on every push to main

📚 Documentation: 17 Comprehensive Module Pages

Every module now has its own dedicated chapter in docs/src/modules/, each containing:

  • Full alias/function reference with description, usage signature, and shell output examples
  • Platform-specific notes and tips where relevant
  • Injected footer via mdbook-template

Modules 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 Detection

Added $AK_OS environment variable exported at load time:

AK_OS="linux"   # Default Linux
AK_OS="macos"   # Darwin / macOS
AK_OS="wsl"     # Windows Subsystem for Linux
AK_OS="windows" # Git Bash / MINGW / Cygwin

@maruf-pfc maruf-pfc self-assigned this Apr 5, 2026
@maruf-pfc
maruf-pfc merged commit 407fd8c into blackstart-labs:main Apr 5, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant