mirror of
https://gitlab.com/KenanZhu/AutoLibraryManuals.git
synced 2026-11-05 05:35:51 +08:00
Clean up Mintlify starter template and set up AutoLibrary structure
Remove sample pages (essentials, agent-ready, ai-tools, api-reference, snippets). Update docs.json with AutoLibrary branding and navigation structure. Rewrite index.mdx as AutoLibrary landing page. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
1 parent
04174b399f
commit
73528d076a
25 files changed
+129
-1765
No files matched your search
@@ -1,55 +1,38 @@
|
||||
# Mintlify Starter Kit
|
||||
# AutoLibrary 用户手册
|
||||
|
||||
Use the starter kit to get your docs deployed and ready to customize.
|
||||
AutoLibrary 北京建筑大学图书馆自动化工具的 Mintlify 文档站点。
|
||||
|
||||
Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
|
||||
## 开发
|
||||
|
||||
- Guide pages
|
||||
- Navigation
|
||||
- Customizations
|
||||
- API reference pages
|
||||
- Use of popular components
|
||||
|
||||
**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
|
||||
|
||||
## AI-assisted writing
|
||||
|
||||
Set up your AI coding tool to work with Mintlify:
|
||||
|
||||
```bash
|
||||
npx skills add https://mintlify.com/docs
|
||||
```
|
||||
|
||||
This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.
|
||||
|
||||
See the [AI tools guides](/ai-tools) for tool-specific setup.
|
||||
|
||||
## Development
|
||||
|
||||
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
|
||||
安装 [Mintlify CLI](https://www.npmjs.com/package/mint) 以在本地预览文档更改:
|
||||
|
||||
```
|
||||
npm i -g mint
|
||||
```
|
||||
|
||||
Run the following command at the root of your documentation, where your `docs.json` is located:
|
||||
在 `docs.json` 所在目录运行:
|
||||
|
||||
```
|
||||
mint dev
|
||||
```
|
||||
|
||||
View your local preview at `http://localhost:3000`.
|
||||
在 `http://localhost:3000` 查看本地预览。
|
||||
|
||||
## Publishing changes
|
||||
## 发布
|
||||
|
||||
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
|
||||
更改推送到默认分支后将自动部署到生产环境。
|
||||
|
||||
## Need help?
|
||||
## 文档结构
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
|
||||
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
|
||||
|
||||
### Resources
|
||||
- [Mintlify documentation](https://mintlify.com/docs)
|
||||
```
|
||||
├── docs.json # Mintlify 配置与导航
|
||||
├── index.mdx # 首页
|
||||
├── versions/ # 版本手册
|
||||
│ ├── v1.3.0.mdx
|
||||
│ ├── v1.2.1.mdx
|
||||
│ ├── ...
|
||||
│ └── v0.0.3-alpha.mdx
|
||||
├── autoscript.mdx # AutoScript 语法参考
|
||||
├── logo/ # Logo 资源
|
||||
└── images/ # 图片资源
|
||||
```
|
||||
Reference in new issue
Block a user