docs: update document website

EINDEX · Sep 16, 2024 · 2d84db6 · 2d84db6
1 parent 45a35dd
commit 2d84db6
Show file tree

Hide file tree

Showing 59 changed files with 11,871 additions and 0 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/docs/babel.config.js b/docs/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/changelog.js b/docs/changelog.js
@@ -0,0 +1,40 @@
+const axios = require("axios");
+const fs = require("node:fs");
+
+const formatBody = (body) => {
+  let ret = body.trim().replaceAll(/<img.*src="(.*?)".*?>/g, "![]($1)");
+  ret = ret.replaceAll(
+    /https:\/\/github.com\/EINDEX\/logseq-copilot\/(issues|pull)\/(\d+)/g,
+    "[$1 #$2](https://github.com/EINDEX/logseq-copilot/$1/$2)"
+  );
+  const re = new RegExp(/^#{1,2} /gm);
+  while (ret.match(re)) {
+    ret = ret.replaceAll(/^(#+ )/gm, "#$1");
+  }
+  ret = ret.replaceAll(/@([\w\-_]+)/g, "[@$1](https://github.com/$1)");
+  return ret;
+};
+
+const main = async () => {
+  const resp = await axios({
+    method: "GET",
+    url: "https://api.github.com/repos/EINDEX/logseq-copilot/releases",
+    headers: {
+      Accept: "application/vnd.github+json",
+      "X-Github-Api-Version": "2022-11-28",
+    },
+  });
+  if (resp.status !== 200) {
+    return;
+  }
+  const data = fs.readFileSync("changelog.template.md");
+  let ret = data;
+  for (const item of resp.data) {
+    ret += `## [${item.name}](${item.url})
+
+${formatBody(item.body)}\n`;
+  }
+  fs.writeFileSync("./docs/changelogs.md", ret);
+};
+
+main();
diff --git a/docs/changelog.template.md b/docs/changelog.template.md
@@ -0,0 +1,2 @@
+# Changelogs
+
diff --git a/docs/docs/changelogs.md b/docs/docs/changelogs.md
@@ -0,0 +1,222 @@
+# Changelogs
+
+## [v1.15.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/173971866)
+
+### What's Changed
+* Updated Ecosia aside selector by [@Ninluc](https://github.com/Ninluc) in [pull #74](https://github.com/EINDEX/logseq-copilot/pull/74)
+* group block results from same page into single list item by [@AnweshGangula](https://github.com/AnweshGangula) in [pull #66](https://github.com/EINDEX/logseq-copilot/pull/66)
+* Support Logseq DB version by [@EINDEX](https://github.com/EINDEX) [issues #75](https://github.com/EINDEX/logseq-copilot/issues/75)
+
+### New Contributors
+* [@AnweshGangula](https://github.com/AnweshGangula) made their first contribution [in [pull #71](https://github.com/EINDEX/logseq-copilot/pull/71)]([pull #66](https://github.com/EINDEX/logseq-copilot/pull/66))
+
+**Full Changelog**: https://github.com/EINDEX/logseq-copilot/compare/v1.14.4...v1.15.0
+## [v1.14.4](https://api.github.com/repos/EINDEX/logseq-copilot/releases/166896315)
+
+### What's Changed
+* Fix SearXNG search engine is not working by [@EINDEX](https://github.com/EINDEX) for [issues #73](https://github.com/EINDEX/logseq-copilot/issues/73)
+* Added Ecosia search engine integration by [@Ninluc](https://github.com/Ninluc) in [pull #71](https://github.com/EINDEX/logseq-copilot/pull/71)
+
+### New Contributors
+* [@Ninluc](https://github.com/Ninluc) made their first contribution in [pull #71](https://github.com/EINDEX/logseq-copilot/pull/71)
+
+**Full Changelog**: https://github.com/EINDEX/logseq-copilot/compare/v1.14.3...v1.14.4
+## [v1.14.3](https://api.github.com/repos/EINDEX/logseq-copilot/releases/144628307)
+
+
+## [v1.14.2](https://api.github.com/repos/EINDEX/logseq-copilot/releases/144482043)
+
+
+## [v1.14.1](https://api.github.com/repos/EINDEX/logseq-copilot/releases/144106979)
+
+
+## [v1.14.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/143510577)
+
+
+## [v1.13.2](https://api.github.com/repos/EINDEX/logseq-copilot/releases/136962659)
+
+
+## [v1.13.1](https://api.github.com/repos/EINDEX/logseq-copilot/releases/136341423)
+
+
+## [v1.13.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/136100648)
+
+### What's Changed
+
+* feat: support startpage.com by [@EINDEX](https://github.com/EINDEX) in [pull #46](https://github.com/EINDEX/logseq-copilot/pull/46)
+  * but it not readable at dark mode yet, will fix it at next version.
+* feat(format): let link clip link not impact by logseq escape by [@EINDEX](https://github.com/EINDEX) in [pull #52](https://github.com/EINDEX/logseq-copilot/pull/52)
+* feat: add fuzzy search for url page #49 #53 by [@EINDEX](https://github.com/EINDEX) in [pull #54](https://github.com/EINDEX/logseq-copilot/pull/54)
+   * ![](https://github.com/EINDEX/logseq-copilot/assets/13883964/141ab113-5a74-4317-b5ef-179b284ad92c) now you can see fuzzy search for all domain result.
+* fix: fix some issues by [@EINDEX](https://github.com/EINDEX) in [pull #55](https://github.com/EINDEX/logseq-copilot/pull/55)
+
+
+**Full Changelog**: https://github.com/EINDEX/logseq-copilot/compare/v1.12.2...v1.13.0
+## [v1.12.2](https://api.github.com/repos/EINDEX/logseq-copilot/releases/119074848)
+
+
+## [v1.12.1](https://api.github.com/repos/EINDEX/logseq-copilot/releases/117949794)
+
+
+## [v1.12.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/114595681)
+
+### What's Changed
+* We currently using [LiquidJS](https://liquidjs.com/) as template system, now you can using complex logic in your template.
+* BUGFIX : The link to the github release was broken by [@gissehel](https://github.com/gissehel) in [pull #32](https://github.com/EINDEX/logseq-copilot/pull/32)
+* refactor: change time display from single digit to two digits by [@jaeyeopme](https://github.com/jaeyeopme) in [pull #33](https://github.com/EINDEX/logseq-copilot/pull/33)
+
+### New Contributors
+* [@gissehel](https://github.com/gissehel) made their first contribution in [pull #32](https://github.com/EINDEX/logseq-copilot/pull/32)
+* [@jaeyeopme](https://github.com/jaeyeopme) made their first contribution in [pull #33](https://github.com/EINDEX/logseq-copilot/pull/33)
+
+**Full Changelog**: https://github.com/EINDEX/logseq-copilot/compare/v1.11.4...v1.12.0
+## [v1.11.4](https://api.github.com/repos/EINDEX/logseq-copilot/releases/102659594)
+
+
+## [v1.11.3](https://api.github.com/repos/EINDEX/logseq-copilot/releases/102119769)
+
+
+## [v1.11.2](https://api.github.com/repos/EINDEX/logseq-copilot/releases/102097961)
+
+
+## [v1.11.1](https://api.github.com/repos/EINDEX/logseq-copilot/releases/101395966)
+
+Fix:  
+ #22 : Avoid using connect to other event, using one-time message.
+
+**Full Changelog**: https://github.com/EINDEX/logseq-copilot/compare/v1.11.0...v1.11.1
+## [v1.11.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/100670128)
+
+**Feature**:
+- add clip shortcut, default is `Command+Shift+U`.
+
+**Refactor**:
+- Firefox extension moving to V3.
+
+**Full Changelog**: https://github.com/EINDEX/logseq-copilot/compare/v1.10.20...v1.11.0
+## [v1.10.20](https://api.github.com/repos/EINDEX/logseq-copilot/releases/100550227)
+
+*Fix*:
+- #20 
+
+*Enhance* :
+- enhance: logseq copilot API from will change to the same as logseq api from #17
+
+*Other*:
+- docs: update guide
+- behaver: disable float button as default
+- ci: remove semantic-release
+
+**Full Changelog**: https://github.com/EINDEX/logseq-copilot/compare/v1.10.19...v1.10.20
+## [v1.10.19](https://api.github.com/repos/EINDEX/logseq-copilot/releases/99941618)
+
+
+## [v1.10.16](https://api.github.com/repos/EINDEX/logseq-copilot/releases/99048694)
+
+Battal with that auto-release pipeline. I lost, manually release for this time.
+
+
+this version of the code is the same as v1.10.11.
+
+
+- Fix: some connect issues.
+- Refactor: the way to render highlight.
+- feat: remove useless `host_permission`
+
+
+- ci: try to achieve auto release pipeline, but lost.
+## [v1.10.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/98616062)
+
+### [1.10.0](https://github.com/eindex/logseq-copliot/compare/v1.9.1...v1.10.0) (2023-04-08)
+
+
+https://user-images.githubusercontent.com/13883964/230768028-483ee241-7c9c-4588-8f39-0394e6972ba3.mov
+
+
+##### Bug Fixes
+
+
+
+
+* security dependency update ([cebb981](https://github.com/eindex/logseq-copliot/commit/cebb981612c0527ef1d0ad39fed9f66e4d718f96))
+* using background js to open popup link [#11](https://github.com/eindex/logseq-copliot/issues/11) ([70acd5e](https://github.com/eindex/logseq-copliot/commit/70acd5eacb76f08765be24d9abb94e399691b609))
+* using half second to debounce ([7c085c0](https://github.com/eindex/logseq-copliot/commit/7c085c086dd56d0d5567486ab5cecc692edcc84c))
+
+
+##### Features
+
+* add highlight on search result [#6](https://github.com/eindex/logseq-copliot/issues/6) ([29a5355](https://github.com/eindex/logseq-copliot/commit/29a5355c808bc67a816845e857ff0bd556f36abe))
+* upgrade quick capture to clip note ([51f8639](https://github.com/eindex/logseq-copliot/commit/51f8639ca5ed95519587da5e29fbe781fba7855f))
+## [v1.9.1](https://api.github.com/repos/EINDEX/logseq-copilot/releases/94925538)
+
+### [1.9.1](https://github.com/eindex/logseq-copliot/compare/v1.9.0...v1.9.1) (2023-03-08)
+
+
+#### Bug Fixes
+
+* only do search when tab is complete status ([a1f11e4](https://github.com/eindex/logseq-copliot/commit/a1f11e4df1ef5e2598f949acc3eb5a9f677f65e5))
+## [v1.9.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/94752592)
+
+### [1.9.0](https://github.com/eindex/logseq-copliot/compare/v1.8.0...v1.9.0) (2023-03-07)
+
+
+##### Features
+
+* **search engine:** support kagi ([4583d7e](https://github.com/eindex/logseq-copliot/commit/4583d7e3c79e742a362368f8a0f2c8af59338145)), closes [#7](https://github.com/eindex/logseq-copliot/issues/7)
+## [v1.8.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/94745743)
+
+### [1.8.0](https://github.com/eindex/logseq-copliot/compare/v1.7.4...v1.8.0) (2023-03-07)
+
+
+##### Features
+
+* add popup query ([7ccfcb3](https://github.com/eindex/logseq-copliot/commit/7ccfcb3e4ec5711633d00810c163b329d198d10f))
+* add quick capture ([01e7fab](https://github.com/eindex/logseq-copliot/commit/01e7fabda4365dbd8781b49c53a7e153b4e3b96c))
+## [v1.7.4](https://api.github.com/repos/EINDEX/logseq-copilot/releases/93677700)
+
+### [1.7.4](https://github.com/eindex/logseq-copliot/compare/v1.7.3...v1.7.4) (2023-02-25)
+
+
+#### Bug Fixes
+
+* avoid generate error when page is not search engine ([c1ea834](https://github.com/eindex/logseq-copliot/commit/c1ea8348f3035d452920256c84a8c4ae4ff6a69f))
+## [v1.7.3](https://api.github.com/repos/EINDEX/logseq-copilot/releases/93249571)
+
+### [1.7.3](https://github.com/eindex/logseq-copliot/compare/v1.7.2...v1.7.3) (2023-02-22)
+
+
+#### Bug Fixes
+
+* **ci:** change params to glob ([38037c5](https://github.com/eindex/logseq-copliot/commit/38037c59987a4c8158206ed7bc03dd5bb0eab290))
+## [v1.5.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/92934756)
+
+### [1.5.0](https://github.com/eindex/logseq-copliot/compare/v1.4.0...v1.5.0) (2023-02-19)
+
+
+##### Features
+
+* firefox supoort, but block on logseq cors config [#4](https://github.com/eindex/logseq-copliot/issues/4) ([b986702](https://github.com/eindex/logseq-copliot/commit/b986702b48c5941963189aa5e13b957e0545216c))
+## [v1.4.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/92932408)
+
+### [1.4.0](https://github.com/eindex/logseq-copliot/compare/v1.3.0...v1.4.0) (2023-02-19)
+
+
+##### Features
+
+* **search engine:** support bing, duckduckgo, yandex, searx, baidu. ([5db4abe](https://github.com/eindex/logseq-copliot/commit/5db4abe515476bfb139ad434db9ec1d034e17fd5)), closes [#3](https://github.com/eindex/logseq-copliot/issues/3)
+## [v1.3.0](https://api.github.com/repos/EINDEX/logseq-copilot/releases/92917608)
+
+### [1.3.0](https://github.com/eindex/logseq-copliot/compare/v1.2.1...v1.3.0) (2023-02-18)
+
+
+##### Features
+
+* **options:** enhance ux and options page ([3c279f2](https://github.com/eindex/logseq-copliot/commit/3c279f2f4c43297ee30e7e8d5915703b21c1a8f6))
+## [v1.2.1](https://api.github.com/repos/EINDEX/logseq-copilot/releases/92303140)
+
+### [1.2.1](https://github.com/eindex/logseq-copliot/compare/v1.2.0...v1.2.1) (2023-02-14)
+
+
+#### Bug Fixes
+
+* update plugin version ([0827c73](https://github.com/eindex/logseq-copliot/commit/0827c73dd7b0926993cfd22aa6b7a803c2ff50f0))
diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -0,0 +1,27 @@
+---
+sidebar_position: 2
+---
+
+# Install
+
+Now Logseq Copilot suport 3 common browsers.
+
+Click belows links to download.
+
+- [Chrome](https://chrome.google.com/webstore/detail/logseq-copilot/hihgfcgbmnbomabfdbajlbpnacndeihl)
+- [Edge](https://microsoftedge.microsoft.com/addons/detail/logseq-copilot/ebigopegbohijaikegebaaboaomaifoi)
+- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/logseq-copilot/)
+
+:::info
+
+Most browser are support Chrome Extension, if your not using Firefox & Safiry, You can try [Chrome](https://chrome.google.com/webstore/detail/logseq-copilot/hihgfcgbmnbomabfdbajlbpnacndeihl) Version.
+
+:::
+
+:::warning
+
+Safari is not supported because registration in the Apple Developer Program is required, which costs US$99 per year.
+
+If really need, welcome become [sponsor](./sponsor.md).
+
+:::
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
@@ -0,0 +1,16 @@
+---
+sidebar_position: 1
+---
+
+# Introduce
+
+Let's setup **Logseq Copilot in less than 5 minutes**.
+
+## Getting Started
+
+
+### What you'll need
+
+- [Instal Browser Extension](/docs/install.md)
+- [Setup Logseq & Extension](/docs/setup.md)
+