Bx new 9007 | 特厉害计划
  • Why Github?
  • Team
  • Enterprise
  • Explore
  • Marketplace
  • Pricing
Sign inSign up
Watch996
Star102.4k
Fork61.8k
Branch: beex.help
Switch branches/tags
Branches
Tags
  •  
K / Bx new.md
72 lines 5.48 KB
First commit on 8 Jun 2020

    说明

    新建一个项目(一个页面或目录)。

    • 注意

      bx new 的语法可能会在新版中发生变动(如果发现更方便的方式),未来更新时请注意查看此文档。

    基本用法

    • 仅文件

      只在 source 文件夹内新建 foo.md 文件。文件名不需要输入后缀。

      bx new foo
      
    • 目录和文件

      source 目录内新建一个 foo 文件夹,并在这个 foo 文件夹内新建 foo.md 文件。--with-dir 可以简写为 -d

      bx new --with-dir foo
      bx new -d foo
      
    • 仅目录

      只在 source 文件夹内新建 foo 文件夹。--only-dir 没有简写。

      bx new --only-dir foo
      
    • 多站点

      当有多站点存在时,必须通过设置 --site 来指定 source 文件夹。--site 可以简写为 -s--site 与值可以用空格 space 也可以用 = 链接。

      bx new --site=1 foo
      bx new -s=1 -d foo
      bx new -s 1 --only-dir foo
      

    命名规范

    • 特殊字符

      不要使用特殊符号,尤其不要使用 / \ 等,文件系统可能会报错。但你可以在生成 .md 文件后编辑 BeexMeta 中的 title 字段,任何你喜欢的符号都可以用。

      如果你想在更复杂的子目录结构中新建文章,可以新建页面后移动,不影响生成的目标位置,更多参考与 bx gen 有关的章节。

      生成时,名字以符号开头的文件夹和文件可能会有额外的处理逻辑。目前以 _. 开头的项目会被忽略,用于保存不需要发布但又不想为其单独建立目录存储的的源文件。以后可能会添加针对其他符号的处理逻辑,所以不建议使用符号做名字的第一个字符,尽管它们可能是合法的。

    • 空格和连字符

      当你使用 bx new NAME 时,如果你希望 NAME 中带空格。需要用双引号将 NAME 包裹起来。比如,下面是错误的:

      bx new my first article
      

      下面是正确的:

      bx new "my first article"
      

      无论你使用下面哪种方式,文件名都有统一的替换规则,以便最终生成的 URL 是常用格式,因为空格可能会带来问题。如果有特殊需求,可以在新建后编辑相应的名字。通常你需要确认 BeexMeta 中的 target 只含有字母、数字、/-.

      以下两条命令最终效果一样:

      bx new my-first-article
      bx new "my first article"
      

      替换规则为

      • 文件夹、文件名和自动生成的 BeexMeta.target:空格 space 被替换为连字符 -
      • 自动生成的 BeexMeta.title:连字符 - 被替换为空格 space

    相关参考:

    • Beex 入门教程
    • bx gen - 生成最终用于浏览的网页文件。(generate 的缩写)
    • bx run - 启动一个本地服务器以便预览。