create-presmium
重新开始 Presmium 项目:讲座,工作空间,主题网站或插件。 presmium new (从 pnpm add -g @lincyaw/presmium)运行它;那么 pnpm create presmium。
presmium new
presmium new my-lecture --type lecture --title "Tokenization"
presmium new my-course --type workspace --title "Data structures"
presmium new my-site --type site --theme course --title "My course"
presmium new presmium-plugin-greeting --type plugin --name presmium-plugin-greeting
如果没有参数,它会询问项目的类型、目录和标题(或者,对于插件,是包的名称)。
| 选项 | 什么 |
|---|---|
--type <kind> | lecture (一个文档), workspace (文件预览用 presmium serve), site (一个主题工作区与主页和GitHub页面工作流)或 plugin |
--theme <name> | 为 site: course (默认), docs 或 showcase |
--title <text> | 讲座或工作区的标题(默认:目录名) |
--name <name> | 插件的包名(默认:目录名) |
--no-git | 不要跑 git init |
-h, --help | 提供帮助 |
- 讲座:
lecture.json;presmium dev,presmium check,presmium build。 - 一个工作区:
presmium.workspace.yaml第一个文档intro/;presmium serve。 - 一个网站:
presmium.workspace.yaml,一个独立的主页site/home.json,一份教学文件intro/lecture.json,.github/workflows/pages.yml;pnpm install,pnpm serve,pnpm build。 - 一个插件:一个指令,一个在网页和幻灯片中显示的React组件,一个服务器路由,中英文文本,一个示例文档和集成测试;
pnpm install,pnpm test,pnpm dev。
讲座,工作空间和网站列表 presmium 在create- premium自己的版本中作为开发依赖,所以 pnpm install 针;没有它,全球 presmium 构建它们。每个项目都有一个 AGENTS.md (CLAUDE.md 链接到它)和编码代理的高级技能副本 .agents/skills. 问题和新文件的文本采用系统语言(中文或英文)。
主题的网站
presmium new my-site --type site --theme showcase --title 'My work'
cd my-site
pnpm install
pnpm serve
编辑 site/home.json 设计主页和 intro/lecture.json 第一份教学文件。 site.landing.source 选择主页文件;主页内容有自己的结构,而教学文档保留 lecture.json 作为他们唯一的内容权威。改变 site.theme 和 site.params 在 presmium.workspace.yaml 使网站个性化。 pnpm build 出口 dist/web/。
对于您自己的HTML、CSS和JavaScript,将登陆配置替换为 site.landing: { template: './site/home.html' }. HTML条目及其本地资产被捆绑为静态托管; script#presmium-site-data 提供网站的公共文档链接。期间刷新主页以重新构建该模板 pnpm serve;不提供模板热更新。
将项目推送到GitHub存储库,选择 GitHub的行为 在 设置→页面→构建和部署→源代码,然后运行生成的Pages工作流或将其推送到其配置的分支。它读取存储库的Pages基本路径,构建站点并进行部署 dist/web/. 构建仍然是一个普通的静态站点,可以在其他地方托管。
看到 网站主题指南 对于三个预设,支持的参数和页面布局。
许可:apache - 2.0。