search

Redish101 / reblog

基于go的自托管博客系统
https://reblog-docs.vercel.app
GNU General Public License v3.0
15 stars 3 forks source link

feat: 文档 #24

Closed Redish101 closed 3 months ago

Redish101 commented 3 months ago

新增文档。 远期TODO: http-api的内嵌。

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@Redish101 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 29 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 9410c2da1bd9d4439ba75a590a15dceb3aedb254 and 7954d483cc87b00203f805e5ec5abf94998791e6.

Walkthrough

本次更改引入了一系列新文件和配置，旨在为 reblog 文档网站提供支持。新增的 .gitignore 文件确保构建产物不被跟踪，而 TypeScript 声明文件和配置信息提升了开发体验。此外，文档内容丰富，涵盖了主题管理和初始设置，确保用户能够顺利入门。同时，Makefile 的更新提升了依赖管理的一致性。

Changes

文件路径 更改摘要
packages/docs/.gitignore 新增 .gitignore 文件，忽略 .next 目录。
packages/docs/next-env.d.ts 新增 TypeScript 声明文件，包含 Next.js 类型引用。
packages/docs/next.config.mjs 新增配置文件，设置 Nextra 框架的主题。
packages/docs/package.json 新增 package.json，管理 @reblog/docs 包的元数据和依赖。
packages/docs/pages/_meta.json 新增结构化元数据，支持中文内容导航。
packages/docs/pages/develop/_meta.json 新增主题相关的 JSON 配置。
packages/docs/pages/develop/themekit.mdx 新增文档，介绍 ThemeKit 库的使用和功能。
packages/docs/pages/getting-started.mdx 新增设置指南，涵盖了前后端的部署过程。
packages/docs/pages/index.mdx 新增关于 reblog 博客系统的文档页面。
packages/docs/theme.config.tsx 新增主题配置文件，定义文档的外观和功能。
packages/docs/tsconfig.json 新增 TypeScript 配置文件，设定编译选项和文件处理规则。
packages/themekit/.gitignore 在 .gitignore 中新增对 .DS_Store 的忽略。
packages/themekit/README.md 移除 "Options" 和 "LICENSE" 部分，简化文档。
packages/themekit/src/index.ts 修改 ThemeKit 类的导出声明，增强模块结构清晰度。
turbo.json 扩展构建任务的输出，包含 .next/** 目录，简化开发流程。
Makefile 修改 install-dev 目标，确保安装时使用锁定文件以增强依赖管理的一致性。

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    participant ThemeKit

    User->>Documentation: 查看文档
    Documentation->>ThemeKit: 获取主题信息
    ThemeKit-->>Documentation: 返回主题数据
    Documentation-->>User: 显示文档内容

Poem

🐇 在兔子跳跃的时光里，
新文件闪耀如星空，
文档导航更灵动，
开发体验无比欢快，
兔子欢呼：“我们一起飞！” 🐰✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.