[feat] Add Reference Section for each doc

A `<detail>` section called "资源及外部链接" is added to each existing document, to provide references. [doc] Polish project README.md Project README is now up-to-date with n1cogrv/n1cogrv. note:`ipkb-bookmark.png`, [fix] Fix _indexing-table.mdx rendering style in mobile devices In mobile devices or small window size, _indexing-table will become a bit "un-readable". A mandatory width styling is added to the table via a wrapping `<div>` [fix] Fix svg icon on homepage display in light/dark mode Add a css filter attribute to `.HomepageFeatures.featureSvg[data-theme="dark"]`
n1cogrv · May 10, 2024 · caca575 · caca575
1 parent 6f84014
commit caca575
Show file tree

Hide file tree

Showing 18 changed files with 187 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,81 @@
 # IPKB 
 
-An Intellectual Property Knowledge Base
+![Intellectual Property Knowledge Base](./ipkb-bookmark.png)
+
+
+
+<p align="center">
+<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/n1cogrv/ipkb?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2Fn1cogrv%2Fipkb">
+<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/n1cogrv/ipkb?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2Fn1cogrv%2Fipkb">
+<img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/n1cogrv/ipkb?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2Fn1cogrv%2Fipkb%2Ftags">
+</p>
+
+<p align="center">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/n1cogrv/ipkb/test-build.yml?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2Fn1cogrv%2Fipkb%2Factions">
+<img alt="GitHub deployments" src="https://img.shields.io/github/deployments/n1cogrv/ipkb/production?style=for-the-badge&label=Production%20Build&link=https%3A%2F%2Fgithub.com%2Fn1cogrv%2Fipkb%2Fdeployments%2FProduction">
+<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/n1cogrv/ipkb?style=for-the-badge&label=Last%20Commit&link=https%3A%2F%2Fgithub.com%2Fn1cogrv%2Fipkb%2Fcommits%2Fmaster%2F">
+</p>
 
 ---
 
-@n1cogrv
+### What exactly is IPKB
+
+Featuring Intellectual Property Laws and Regulations, IPKB is built specifically for intellectual property practitioners, such as IP attorneys, patent engineers, and IP paralegal assistants. It organizes legal text in a unique way familiar to the industry, and offers approaches to search, locate, index, and reference IP-relevant legal text.
+
+### IPKB is open-source and commercial-free
+
+Empowering IP professionals, IPKB is an open-source platform specifically designed for intellectual property practitioner. While it offers the robust features you need to streamline your workflow, IPKB goes a step further by being completely free to use commercially. 
+
+You can deploy IPKB locally following the steps [below](#steps-to-deploy-ipkb-locally).
+
+### Steps to deploy IPKB locally
+
+IPKB is built using Docusaurus.
+
+**Prerequisites:**
+
+* NodeJS version 20 or later ([NodeJS](https://nodejs.org/))
+* `npm` Package Manager (included with NodeJS installation)
+
+**Steps:**
+
+1. **Clone the IPKB repository:**
+
+   ```bash
+   git clone https://github.com/n1cogrv/ipkb.git
+   cd ipkb
+   ```
+
+2. **Install dependencies:**
+
+   ```bash
+   npm install
+   ```
+
+3. **Start the development server:**
+
+   ```bash
+   npm run dev
+   ```
+
+   This will start a local development server for IPKB. You can access the platform at `http://localhost:3000` in your web browser.
+
+**Additional Notes:**
+
+* The development server will automatically watch for changes in the code and refresh the browser accordingly.
+* To build the project for production deployment and serving it locally, you can run:
+
+   ```bash
+   npm run build
+   npm run serve
+   ```
+
+   This will create an optimized production build in the `build` folder. Please note that some features, such as `search` feature, require IPKB to be run in `PRODUCTION` mode rather than `npm run dev`.
+
+### Contributing to IPKB:
+
+**Contributions are welcomed to IPKB!** 🎉  
+
+If you find any issues or have suggestions for improvement, please [open an issue on GitHub](https://github.com/n1cogrv/ipkb/issues/new).
+
+
diff --git a/docs/_indexing-table.mdx b/docs/_indexing-table.mdx
@@ -1,3 +1,4 @@
+<div style={{width:950+"px", display:"inline-block"}}>
 
 | 索引值                 | 标题                                                            | 文本全称                         | 施行日期   | 外部参考1                                                                 | 外部参考2                                                                               |
 | ---------------------- | --------------------------------------------------------------- | -------------------------------- | ---------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
@@ -11,3 +12,5 @@
 | [PCTA](/search?q=PCTA) | [专利合作条约](./专利合作条约2001.md)                           | 专利合作条约                     | 2002-04-01 | [TRT/PCT/001](https://www.wipo.int/wipolex/zh/treaties/textdetails/12635) |                                                                                         |
 | [PAR](/search?q=PAR)   | [专利代理条例](./中华人民共和国专利代理条例2018.md)             | 中华人民共和国专利代理条例       | 2019-03-01 |                                                                           | [🔗](https://flk.npc.gov.cn/detail2.html?ZmY4MDgwODE2ZjNlOThiZDAxNmY0MjU5M2JiMzA1NDI%3D) |
 | [AAM](/search?q=AAM)   | [专利代理管理办法](./中华人民共和国专利代理管理办法2019.md)     | 中华人民共和国专利代理管理办法   | 2019-05-01 |                                                                           | [🔗](https://www.gov.cn/zhengce/zhengceku/2019-10/21/content_5442904.htm)                |
+
+</div>
diff --git a/docs/index.mdx b/docs/index.mdx
@@ -26,9 +26,9 @@ export const CtrlButton = () => (
 
 :::tip
 
-表格中所提供的文本均为相应文本的现行版本，其中外部参考1来自WIPO LEX站点，外部参考2来自文本所属国或地区的政府或权威站点。
+**阁下引用本站作为正式文书内容时，将被视为已阅读并知晓[关于本站](/about)页面的内容。**
 
-引用本站作为正式文书内容时，视为你已阅读并知晓[关于本站](/about)页面的内容。
+表格中所提供的文本均为相应文本的现行版本，其中外部参考1来自WIPO LEX站点，外部参考2来自文本所属国或地区的政府或权威站点。
 
 此外，本站提供的电子文本与标准文本不一致时，请根据中华人民共和国立法法（包括但不限于第58条、第71条、第79条、第86条）的相关规定，对应地以下列的一项或多项作为标准文本：
 

diff --git a/docs/专利合作条约2001.md b/docs/专利合作条约2001.md
@@ -17,6 +17,13 @@ toc_max_heading_level: 2
 阁下可以复制位于各法条后的直达链接，以实现对任意法条的<a href="#PCTA28"> 站内跳转 </a> 或 <a href="#PCTA28" target="_blank" rel="noopener noreferrer"> 站外引用 </a>。
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [WIPO Lex](https://www.wipo.int/wipolex/zh/treaties/textdetails/12635)
+</details>
+
 :::note[修正说明]
 
 当前版本修改于2001年10月3日；**生效于2002年4月1日**。

diff --git a/docs/中华人民共和国专利代理条例2018.md b/docs/中华人民共和国专利代理条例2018.md
@@ -17,6 +17,14 @@ toc_max_heading_level: 2
 
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [公报](https://flk.npc.gov.cn/detail2.html?ZmY4MDgwODE2ZjNlOThiZDAxNmY0MjU5M2JiMzA1NDI%3D)
+        + [北大法宝](https://law.pkulaw.com/chinalaw/adffa616e7672852bdfb.html)
+</details>
+
 :::note[修订说明]
 
 当前修订成文于2018年9月6日；随[中华人民共和国国务院令第706号](https://www.gov.cn/gongbao/content/2018/content_5343739.htm)发布于2018年11月6日；**施行于2019年3月1日**。

diff --git a/docs/中华人民共和国专利代理管理办法2019.md b/docs/中华人民共和国专利代理管理办法2019.md
@@ -17,6 +17,14 @@ toc_max_heading_level: 2
 
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [公报](https://www.gov.cn/zhengce/zhengceku/2019-10/21/content_5442904.htm)
+        + [北大法宝](https://law.pkulaw.com/chinalaw/275c0a30eeaa2a4fbdfb.html)
+</details>
+
 :::note[修订说明]
 
 当前修订成文于2019年4月1日；随[国家市场监督管理总局令第6号](https://www.gov.cn/gongbao/content/2019/content_5407668.htm)发布于2019年4月4日；**施行于2019年5月1日**。

diff --git a/docs/中华人民共和国专利法2020.md b/docs/中华人民共和国专利法2020.md
@@ -11,12 +11,30 @@ toc_max_heading_level: 2
 
 本文索引前序字符串是**PTA**，速记为**P**a**T**ent Law **A**rticle X。
 
-
 例如，阁下可以在本站任意界面通过组合键 `ctrl+K` 呼出搜索组件，并键入 `PTA2` 以快速定位至专利法**第2条**；或者
 
 阁下可以复制位于各法条后的直达链接，以实现对任意法条的<a href="#PTA2"> 站内跳转 </a> 或 <a href="#PTA2" target="_blank" rel="noopener noreferrer"> 站外引用 </a>。
+
 :::
 
+<!-- <details>
+    <summary>资源及外部链接</summary>
++ [Word](/static/files/)
++ [PDF](/static/file/)
++ [公报]()
++ [北大法宝]()
++ [WIPO LEX]()
+</details> -->
+
+<details>
+    <summary>资源及外部链接</summary>
+    + [Word](/static/files/)
+    + [PDF](/static/file/)
+    + [公报](https://flk.npc.gov.cn/detail2.html?ZmY4MDgwODE3NTJiN2Q0MzAxNzVlNDY1MWNiZDE1NDc%3D)
+    + [北大法宝](https://law.pkulaw.com/falv/417f520f8bcb8de2bdfb.html)
+    + [WIPO LEX](https://www.wipo.int/wipolex/zh/legislation/details/21027)
+</details>
+
 :::note[修正说明]
 
 当前修正通过于2020年10月17日；随[全国人大常委会2020年第五号公报](http://www.npc.gov.cn/wxzlhgb/c27214/gb2020/202011/P020230414512589293101.pdf)公布/出版于2020年11月15日；**施行于2021年6月1日**。

diff --git a/docs/中华人民共和国专利法实施细则2023.md b/docs/中华人民共和国专利法实施细则2023.md
@@ -17,6 +17,15 @@ toc_max_heading_level: 2
 
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [公报](https://flk.npc.gov.cn/detail2.html?ZmY4MDgxODE4ZDczNmRhZTAxOGRjNTE4MmYzMDZjMTQ%3D)
+        + [北大法宝](https://law.pkulaw.com/chinalaw/94a9061f349cec2dbdfb.html)
+        + [WIPO LEX](https://www.wipo.int/wipolex/zh/legislation/details/13395)
+</details>
+
 :::note[修订说明]
 
 当前修订成文于2023年12月11日；随[中华人民共和国国务院令第769号](https://www.gov.cn/zhengce/content/202312/content_6921633.htm)发布于2023年12月21日；**施行于2024年1月20日**。

diff --git a/docs/中华人民共和国商标法2019.md b/docs/中华人民共和国商标法2019.md
@@ -17,6 +17,15 @@ toc_max_heading_level: 2
 阁下可以复制位于各法条后的直达链接，以实现对任意法条的<a href="#TMA2"> 站内跳转 </a> 或 <a href="#TMA2" target="_blank" rel="noopener noreferrer"> 站外引用 </a>。
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [公报](https://flk.npc.gov.cn/detail2.html?ZmY4MDgwODE2ZjEzNWY0NjAxNmYyMTc2NDU0NTFiMzU%3D)
+        + [北大法宝](https://law.pkulaw.com/chinalaw/937235cafaf2a66fbdfb.html)
+        + [WIPO LEX](https://www.wipo.int/wipolex/zh/legislation/details/19559)
+</details>
+
 :::note[修正说明]
 
 当前修正通过于2019年4月23日；随[全国人大常委会2019年第三号公报](http://www.npc.gov.cn/wxzlhgb/c27214/c36614/201908/P020230313535665809353.pdf)公布/出版于2019年5月15日；**施行于2019年11月1日**。

diff --git a/docs/中华人民共和国商标法实施条例2014.md b/docs/中华人民共和国商标法实施条例2014.md
@@ -17,6 +17,15 @@ toc_max_heading_level: 2
 
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [公报](https://flk.npc.gov.cn/detail2.html?ZmY4MDgwODE2ZjNlOTc4NDAxNmY0MjRmZjNhZDA0ZTk%3D)
+        + [北大法宝](https://law.pkulaw.com/chinalaw/2c43887f7b0da4c8bdfb.html)
+        + [WIPO LEX](https://www.wipo.int/wipolex/zh/legislation/details/15011)
+</details>
+
 :::note[修订说明]
 
 当前修订成文于2014年4月29日；随[国务院公报-2014年第14号-中华人民共和国国务院令第651号](https://www.gov.cn/gongbao/content/2014/content_2679357.htm)发布于；**施行于2014年5月1日**。

diff --git a/docs/中华人民共和国植物新品种保护条例2014.md b/docs/中华人民共和国植物新品种保护条例2014.md
@@ -17,6 +17,15 @@ toc_max_heading_level: 2
 
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [公报](https://flk.npc.gov.cn/detail2.html?ZmY4MDgwODE2ZjNjYmIzYzAxNmY0MDhjZjM2NTA0MWU%3D)
+        + [北大法宝](https://law.pkulaw.com/chinalaw/534e33ba567c55d5bdfb.html)
+        + [WIPO LEX](https://www.wipo.int/wipolex/zh/legislation/details/13449)
+</details>
+
 :::note[修订说明]
 
 当前修订成文于2014年7月9日；随[中华人民共和国国务院令第653号](https://www.gov.cn/gongbao/content/2016/content_5139623.htm)发布于2014年7月29日；**施行于2014年7月29日**。

diff --git a/docs/中华人民共和国著作权法2020.md b/docs/中华人民共和国著作权法2020.md
@@ -17,6 +17,15 @@ toc_max_heading_level: 3
 
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [公报](https://flk.npc.gov.cn/detail2.html?ZmY4MDgwODE3NTJiN2Q0MzAxNzVlNDc2NmJhYjE1NTc%3D)
+        + [北大法宝](https://law.pkulaw.com/chinalaw/a3b3a54bea64f090bdfb.html)
+        + [WIPO LEX](https://www.wipo.int/wipolex/zh/legislation/details/21065)
+</details>
+
 :::note[修正说明]
 
 当前修正通过于2020年11月11日；随全国人大常委会2021年第一号公报公布/出版于2021年1月15日；**施行于2021年6月1日**。

diff --git a/docs/中华人民共和国著作权法实施条例2013.md b/docs/中华人民共和国著作权法实施条例2013.md
@@ -17,6 +17,15 @@ toc_max_heading_level: 2
 
 :::
 
+<details>
+    <summary>资源及外部链接</summary>
+        + [Word](/static/files/)
+        + [PDF](/static/file/)
+        + [公报](https://flk.npc.gov.cn/detail2.html?ZmY4MDgwODE2ZjNjYmIzYzAxNmY0MDk4ODA2NjA0ZmM%3D)
+        + [北大法宝](https://law.pkulaw.com/chinalaw/9cf4d322129fe9d6bdfb.html)
+        + [WIPO LEX](https://www.wipo.int/wipolex/zh/legislation/details/13428)
+</details>
+
 :::note[修订说明]
 
 当前修订成文于2013年1月16日；随[中华人民共和国国务院令第633号](https://www.gov.cn/gongbao/content/2013/content_2339485.htm)发布于2013年1月30日；**施行于2013年3月1日**。

diff --git a/ipkb-bookmark.png b/ipkb-bookmark.png
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ipkb",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

diff --git a/src/components/HomepageFeatures/styles.module.css b/src/components/HomepageFeatures/styles.module.css
@@ -8,4 +8,9 @@
 .featureSvg {
   height: 150px;
   width: 150px;
+  filter: none;
+}
+
+.featureSvg[data-theme="dark"] {
+  filter: invert(100%);
 }
diff --git a/src/pages/about/index.mdx b/src/pages/about/index.mdx
@@ -46,6 +46,6 @@ IPKB当前版本为v{useDocusaurusContext().siteMetadata.siteVersion}，由Docus
 
 ### 4. 通知和联系
 
-如果阁下认为本站上的内容侵犯了您的知识产权或其他权利，请通知维护者：联系方式：[copyright@ipkb.jasonchen.icu](mailto:copyright@ipkb.jasonchen.icu)。
+如果阁下认为本站上的内容侵犯了您的知识产权或其他权利，请通知维护者：联系方式：[mail@jasonchen.icu](mailto:mail@jasonchen.icu?subject=!COPYRIGHT_NOTICE!)。
 
-如有任何其他问题或建议，请联系维护者：联系方式：[admin@ipkb.jasonchen.icu](mailto:admin@ipkb.jasonchen.icu)。
+如有任何其他问题或建议，请联系维护者：联系方式：[mail@jasonchen.icu](mailto:mail@jasonchen.icu)。