@ irmark/ quiver (英语)

A 类 奎尔马克 空军的源头发抖, DAF和陆军官方文件的毛笔,来源于 舌尖收集 ,并与当前 Quillmark spec 对齐.

目录

安装

npm install @airmark/quiver @quillmark/quiver @quillmark/wasm

这套包装的是源-奎弗资产(Quiver.yaml + 键 quills/)和 正式 模板,并曝光无JavaScript API. 装入是 @quillmark/quiver'',渲染是 @quillmark/wasm对.

使用量

从已安装的目录( 节点) 装入

解决此软件包 Quiver.yaml 从您自己的模块中调用 : 您的依赖性为 可以从你那里,而不是从装货机的安装位置—— 手拿它 目录到 fromDir数字 :

import { createRequire } from 'node:module';
import { dirname } from 'node:path';
import { Engine, init } from '@quillmark/wasm';
import { fromDir } from '@quillmark/quiver/node';

// `init` is the only door to `Document`: there is no static export to reach early.
const { Document } = await init();

const root = dirname(createRequire(import.meta.url).resolve('@airmark/quiver/Quiver.yaml'));
const quiver = await fromDir(root);
const engine = new Engine();

const doc = Document.fromMarkdown(`~~~
$quill: [email protected]
$kind: main
memo_for: ["ORG/SYMBOL"]
memo_from: ["ORG/SYMBOL", "Organization Name", "123 Street Ave", "City ST 12345-6789"]
subject: Hello Quillmark
signature_block: ["FIRST M. LAST, Rank, USAF", "Duty Title"]
~~~

Body of the memo.`);

const quill = await quiver.getQuill(doc.quillRef);
const { artifacts } = await engine.render(quill, doc, { format: 'pdf' });

一个毛笔从 getQuill 被借用:每个打电话要求裁判的人都会收到 同样的情况,所以它不是你的 free()。 。 。 .

装入 HTTP (浏览器)

浏览器无法读取源版式, 因此在部署时打包并服务于 输出为静态文件 :

import { build } from '@quillmark/quiver/node'; // build step
await build(root, './public/quivers/airmark');

import { Quiver } from '@quillmark/quiver'; // browser runtime
const quiver = await Quiver.fromBuiltUrl('/quivers/airmark/');

版式

这个软件包是 源词 符合条形布局 :

Quiver.yaml
quills/
  <name>/
    <x.y.z>/
      Quill.yaml
      plate.typ
      assets/
      packages/
templates/
  templates.json
  <file>.md

模板

templates/ 持有官方启动文件 模板库。 他们坐在起伏处,而不是里面 装货者从不读 消费者以文件的形式传阅 @airmark/quiver/templates/templates.json 和马克下它的名字。 每个条目 实值 { id, name, description, file, tags },而每个列出的模板都是活的.

一个入口 id 这是永久的。 切入到奎尔的行 ID 它的共享短代码,所以重命名一个 退休旧模板(它) 星等及其与之相伴的短码),并出版一款新作. 删除条目 以同样的方式退休.

npm test 使每个模板都与此微软相匹配 quillkit check,以及 警告失败如出一辙, 所以一个折断模板的圆点变化 这里失败了,而不是在应用的构造.

写毛笔

两个动词,它们回答不同的问题.

两个动词都是 quillkit毛笔 作者的工具链。 它携带 @quillmark/quiver 财务报告和审定财务报表 @quillmark/wasm 准确 版本,所以升级的 quillkit 升级格式的 quiver 装入和 城门经过的原地 此收藏将相同的两个版本钉入 页:1 scripts/check-examples.mjs 财务报告和审定财务报表 scripts/check-templates.mjs,则 通过他们.

有用吗? quillkit check 装入收藏 fromDir编辑 每分每分 每分每分每分每分 每分每分每分每分每分每分 每分每分每分每分每分每分每分 每分每分每分每分每分每分每分每分每分 每分每分每分每分每分每分每分每分每分每分每分每分 类型 seed: 撰写和渲染 default: 或它的空白,及其 例如,一个已填入的已编出值的一页:每个字段的种子 example: 和每类的 body.example 承诺,每样一张卡. npm test 而不施以任何譬喻或警告者, 和警告的模版. 这是CI的门,所以验证失败 表面在这里,而不是在一个 消费者建筑:

npm install
npm test

门每毛笔就有一个答案,所以一个有长长的列表或 在其中包装值是设计固定器的锻炼(design/) (中文(简体) ).

用起来是什么感觉? npm run dev 实值 quillkit serve: 它包着这个 包括草稿在内的微词,为工作室客户端服务,并重新包装 保存 —— 选取一 qui,编辑其示例(或,与 实例 它的子孙, 注意它油漆,读取诊断。 客户是quillkit的,所以有 没有安装它, 没有保持步入.

取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取. 将一 qui编辑为无效状态不是 循环的失败:它包了起来,客户会说出什么错 和在哪里, 而其他人仍然可以使用.

quillkit check 所以大门是权威的录音室 是一种咨询,虽然两者都通过 被"被"的quillkit 承载.

npm run build 将部署服务中的安排写入 dist/ - 客户 在根部,一个被建造的起伏 quiver/ 在它下面,不为它服务。 这个 通过 --drafts,所以请 0.0.x 原型装在放电口旁边 npx quillkit preview 作为静态的宿主 CI 上传到每个 运行,所以通过下载该程序来审查拉动请求——包括了叉子 文物和提供目录。 工作室不打开模板; npm test 他们的大门是什么.

main 部署到 GitHub 页面 .github/workflows/studio.yml,运行中 同一命令并保留在此的部署 : 此寄存器之外没有任何 持有 pages: write。 。 。 .

vercel.json 向 Vercel 部署相同的布局,其中拉出请求 预览 URL 而不是要下载的文物 。 它携带的建筑,输出 目录和一个缓存规则,一个主机欠这个布局—— assets/* 不可改变, 这是工作室自己的捆绑, 和所有其它已经正确的 默认。 导入 仓库是设置的其余部分。 两次部署都跑了 main 也没有 知道另一个.

许可证

Apache-2.0, 下方的毛笔包 quills/ 列入,但 classic_resume是因为 ttq-classic-resume这是麻省理工学院 两样东西一分钱 拖放不是工程的许可: 字体是包捆, 包捆 保持自身的上游条件——见 packages/ 每一毛笔中的目录 - 还有DoD和DoW的封口 quills/*/*/assets/,是美国 政府徽章,其使用有相应规定.