SuperAPI AI 工具集

bx-sites-getting-started

通用与其它

查看项目

更新于 10-16 03:13

技能介绍

用途:BxSites 是 BoxLang 编写的静态站点生成器,把 Markdown 文件夹构建为带主题和搜索的静态站点,可用于文档、博客、营销站或知识库。

安装:需先装 BoxLang 运行时,依赖 bx-markdown、bx-esapi、bx-yaml、bx-image 会自动安装。安装命令:curl -fsSL https://install.boxlang.io/ | bash,或 curl -fsSL https://install-bvm.boxlang.io/ | bash && bvm install latest && bvm use latest;随后 install-bx-module bx-sites 或 box install bx-sites。

主要能力:bxSites new 脚手架新项目;bxSites migrate 迁移 GitBook、mkdocs、Markdown zip、Notion 项目;bxSites page:new 新建页面;bxSites page:rename 移动页面并自动改写链接与 redirect_from;bxSites build 生成到 site/;bxSites serve 本地预览(默认 http://127.0.0.1:8080/,支持热重载);bxSites clean 清理。页面支持 frontmatter(title、order、hidden、description、tags、icon、summary、ogImage、toc、redirect_from、layout),链接用 .md 文件相对路径并在构建时转为漂亮 URL,每个页面同时发布原始 Markdown 供下载。

用法:项目含 bxsites.yaml(或 .toml/.json)配置、docs/ 或 src/ 内容目录(assets/、blog/、versions/、i18n/、includes/ 为保留目录),输出始终到 site/。所有命令支持 --projectRoot=<path>,标志统一用 --flag=value。

适用场景:需要从 Markdown 快速生成可搜索静态站点、迁移既有文档、或搭建营销/作品集站点。

限制:frontmatter 是自研解析器而非完整 YAML,不支持嵌套对象;migrate 会覆盖目标位置的 bxsites.yaml/docs/nav.json;serve 默认端口 8080。其他功能如部署、主题等细节需参考对应 skill,资料未提供更详细内容。