# cf-notepad 使用手册
这是一份给当前部署版本准备的简明帮助页，常用入口如下：
- 首页：https://note.imxa.top/
- 后台管理：https://note.imxa.top/admin
- 帮助页：https://note.imxa.top/help
- 当前页面原文：https://note.imxa.top/raw/help
## 基本用法
打开任意单级路径即可创建或查看页面，例如：
- https://note.imxa.top/note
- https://note.imxa.top/todo
- https://note.imxa.top/install.sh
页面内容使用 Markdown 编写。保存后可以在页面底部切换主题、设置密码、发布分享，或者进入后台统一管理。
## 后台管理
后台固定入口是：
https://note.imxa.top/admin
后台可以做这些事：
- 新建页面
- 编辑已有页面内容
- 将页面设为只读或取消只读
- 删除页面
- 清理空页面
只读页面会像公开文章一样展示，不显示普通编辑器。只读页面仍然可以在后台修改。
## API 写入
可以通过 API 远程写入或更新页面：
```bash
curl -X POST https://note.imxa.top/api/example \
-H "Content-Type: application/json" \
-d '{"text":"# Hello\n\n这是一篇通过 API 创建的页面。","share":true}'
```
常用字段：
- `text`：页面正文
- `content`：`text` 的兼容别名
- `append`：为 `true` 时追加内容
- `share` 或 `public`：是否生成公开分享链接
- `theme`：Markdown 主题
- `pw`：编辑密码
- `vpw`：查看密码
只读页面不能通过普通 API 修改，只能在后台改。
## Raw 原文入口
现在支持直接读取页面原文：
```bash
curl -fsSL https://note.imxa.top/raw/help
```
这个入口适合拉取 Markdown、配置片段或脚本文件。比如你创建了 `install.sh` 页面，可以这样读取：
```bash
curl -fsSL https://note.imxa.top/raw/install.sh
```
如果页面设置了查看密码，可以这样传密码：
```bash
curl -fsSL "https://note.imxa.top/raw/install.sh?pw=你的密码"
```
或者使用 Bearer：
```bash
curl -fsSL https://note.imxa.top/raw/install.sh \
-H "Authorization: Bearer 你的密码"
```
注意：`/raw/:path` 返回的是当前最新版内容，不是 GitHub commit raw 那种固定快照。如果要把脚本公开给别人执行，建议使用版本路径，例如 `install-v1.0.0.sh`，不要只依赖永远变化的 `install.sh`。
## 已同步的原项目文档
我把原始项目 `serverless-cloud-notepad` 的 Markdown 文档同步到了下面这些页面，方便后期查看：
- 原项目 README：https://note.imxa.top/docs-upstream-readme
- 原项目 README 中文版：https://note.imxa.top/docs-upstream-readme-zh-cn
对应 raw 原文入口：
- https://note.imxa.top/raw/docs-upstream-readme
- https://note.imxa.top/raw/docs-upstream-readme-zh-cn