gitalk-react 1.0.0-beta.2 → 1.0.0-beta.3

package/README-zh-CN.md

@@ -1,7 +1,12 @@
+基于 Github 议题和 React 的现代评论组件。
+
 [ENGLISH](./README.md) | 简体中文
 
 # Gitalk React
 
+[![NPM][npm-version-image]][npm-version-url]
+[![gzip-size][gzip-size]][gzip-url]
+
 使用 TypeScript, React 和 Vite 重新实现 [Gitalk](https://github.com/gitalk/gitalk) —— 基于 Github 议题的评论组件。
 
 面向现代浏览器开发，专注于减少构建包的体积，提升开发与使用的体验。
@@ -81,7 +86,7 @@ Gitalk 依赖于 Github OAuth App 实现登录鉴权，您需要首先[注册一
 
 **必填项**。Gitalk 管理员列表。可以是 Github 仓库的拥有者和协作者：拥有对此仓库**写权限**的用户。
 
-### id `string = location.href`
+### id `string = location.pathname`
 
 评论议题的唯一标识符，长度不能超过 50。
 
@@ -89,7 +94,7 @@ Gitalk 在创建评论议题时，自动将此参数作为评论议题的标签
 
 对于博客等类型的站点，推荐将页面的 `slug` 作为参数。
 
-### number `number = -1`
+### number `number`
 
 评论议题的编号。
 
@@ -255,3 +260,8 @@ yarn build
 ## 许可证
 
 [MIT](./LICENSE)
+
+[npm-version-image]: https://img.shields.io/npm/v/gitalk-react.svg?style=flat-square
+[npm-version-url]: https://www.npmjs.com/package/gitalk-react
+[gzip-size]: https://img.badgesize.io/https://unpkg.com/gitalk-react/dist/gitalk.umd.cjs?compression=gzip&style=flat-square
+[gzip-url]: https://unpkg.com/gitalk-react/dist/gitalk.umd.cjs

package/README.md

@@ -1,7 +1,12 @@
+Modern comment component based on GitHub Issue and React.
+
 ENGLISH | [简体中文](./README-zh-CN.md)
 
 # Gitalk React
 
+[![NPM][npm-version-image]][npm-version-url]
+[![gzip-size][gzip-size]][gzip-url]
+
 Reimplementing [Gitalk](https://github.com/gitalk/gitalk) with TypeScript, React, and Vite — a comment component based on GitHub issues.
 
 Developed for modern browsers, focusing on reducing build size and enhancing development and usage experience.
@@ -81,7 +86,7 @@ When using the Gitalk component, fill in the necessary configuration items:
 
 **Required**. A list of Gitalk administrators. This can include users who have write access to this repository: owners and collaborators.
 
-### id `string = location.href`
+### id `string = location.pathname`
 
 A unique identifier for the comment topic; length cannot exceed 50 characters.
 
@@ -89,7 +94,7 @@ When creating a comment topic, Gitalk automatically uses this parameter as a lab
 
 For blog-type sites, it is recommended to use the page's slug as this parameter.
 
-### number `number = -1`
+### number `number`
 
 The number of the comment topic.
 
@@ -255,3 +260,8 @@ yarn build
 ## License
 
 [MIT](./LICENSE)
+
+[npm-version-image]: https://img.shields.io/npm/v/gitalk-react.svg?style=flat-square
+[npm-version-url]: https://www.npmjs.com/package/gitalk-react
+[gzip-size]: https://img.badgesize.io/https://unpkg.com/gitalk-react/dist/gitalk.umd.cjs?compression=gzip&style=flat-square
+[gzip-url]: https://unpkg.com/gitalk-react/dist/gitalk.umd.cjs

package/dist/gitalk.d.ts

@@ -49,14 +49,12 @@ declare interface GitalkProps extends Omit<default_2.HTMLAttributes<HTMLDivEleme
      * The unique id of the page.
      * Length must less than 50.
      *
-     * @default location.href
+     * @default location.pathname
      */
     id?: string;
     /**
      * The issue ID of the page.
      * If the number attribute is not defined, issue will be located using id.
-     *
-     * @default -1
      */
     number?: number;
     /**