Skip to content

Commit

Permalink
Merge pull request #7 from n1cogrv/feat-reference-section
Browse files Browse the repository at this point in the history
commit ab974c1 

    [doc-update] Update administrative procedure law
    
    [fix] fix administrative reconsideration law typo
    
    Corresponding entries in `_indexing-table.mdx` are amended.

commit a311c77

    [doc-update] Update administrative reconsideration law
    
    [reference fix] Update links with static word and pdf files
    
    [fix] homepage svg not displaying correctly in dark/light mode
    
    [Add] Jieba dict specific for law doc
    
    [bug]!STILL EXISTS! search function freezes pages when exceeding limit
    
    Search function will cause the search page to freeze when searching
    string is longer than 12-ish CJK characters. A workaround patch is
    added. However the bug still exists, it is believed that this bug comes
    from upstream dependencies.

commit caca575

    [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"]`
  • Loading branch information
n1cogrv authored May 11, 2024
2 parents 6f84014 + ab974c1 commit de9dd87
Show file tree
Hide file tree
Showing 56 changed files with 186,861 additions and 37 deletions.
78 changes: 76 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).


Loading

0 comments on commit de9dd87

Please sign in to comment.