From eae5019266542eff879ee88acfaf8acc4bde786c Mon Sep 17 00:00:00 2001 From: lehuygiang28 Date: Wed, 22 May 2024 10:15:56 +0700 Subject: [PATCH 1/3] chore: and add badges for npm package --- README.md | 8 +++++++- README_en-US.md | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 545b567..e1465e0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# vnpay +# VNPay Lib
@@ -9,6 +9,12 @@

+

+NPM Version +Package License +NPM Downloads +

+ Thư viện mã nguồn mở hỗ trợ thanh toán qua [VNPay](https://vnpay.vn). ## Tài liệu diff --git a/README_en-US.md b/README_en-US.md index a0511df..88d3680 100644 --- a/README_en-US.md +++ b/README_en-US.md @@ -1,4 +1,4 @@ -# VNPay API Nodejs +# VNPay Lib
@@ -9,6 +9,12 @@

+

+NPM Version +Package License +NPM Downloads +

+ An open-source library support to payment with [VNPay](https://vnpay.vn). ## Documentations From ffe4830b75a3e6e8dfd58bdb7e156e9d7f3203e5 Mon Sep 17 00:00:00 2001 From: lehuygiang28 Date: Wed, 22 May 2024 22:46:10 +0700 Subject: [PATCH 2/3] chore: update Docusaurus configuration and metadata --- docs/docusaurus.config.ts | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index feac5dc..3f3a13e 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -41,6 +41,8 @@ const config: Config = { // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: 'https://github.com/lehuygiang28/vnpay/tree/main/docs', + showLastUpdateTime: true, + showLastUpdateAuthor: true, }, blog: false, theme: { @@ -53,6 +55,27 @@ const config: Config = { themeConfig: { // Replace with your project's social card // image: 'img/docusaurus-social-card.jpg', + metadata: [ + { + name: 'description', + content: 'An open-source nodejs library support to payment with VNPay', + }, + { name: 'og:title', content: 'vnpay' }, + { + name: 'og:description', + content: 'An open-source nodejs library support to payment with VNPay', + }, + { name: 'og:url', content: 'https://vnpay-lib.vercel.app' }, + { name: 'og:site_name', content: 'vnpay' }, + { name: 'og:type', content: 'website' }, + { name: 'og:locale', content: 'vi_VN' }, + { name: 'og:locale:alternate', content: 'en_US' }, + { + name: 'keywords', + content: + 'vnpay, nodejs, payment, library, open-source, vnpay api, vnpay doc, vnpay sandbox, vnpay test, vnpay node, vnpay nodejs', + }, + ], navbar: { title: 'lehuygiang28/VNPay', // logo: { @@ -102,6 +125,7 @@ const config: Config = { prism: { theme: prismThemes.vsLight, darkTheme: prismThemes.dracula, + defaultLanguage: 'typescript', }, colorMode: { defaultMode: 'dark', @@ -113,6 +137,17 @@ const config: Config = { indexName: 'vnpay-lib', contextualSearch: true, }, + announcementBar: { + id: 'help_us', + content: ` + We are looking for contributors to help us translate our docs to English. + If you're interested, please check out + this issue on GitHub. + `, + backgroundColor: '#fafbfc', + textColor: '#091E42', + isCloseable: true, + }, } satisfies Preset.ThemeConfig, plugins: [ [ From e0d3f6e913251b500c5b929ed8512c298b92c658 Mon Sep 17 00:00:00 2001 From: lehuygiang28 Date: Wed, 22 May 2024 22:46:35 +0700 Subject: [PATCH 3/3] refactor: update Buy Me A Coffee image in README files --- README.md | 2 +- README_en-US.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e1465e0..b5e4433 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ const vnpay = new VNPay({ #### Thư viện VNPay là một dự án mã nguồn mở và miễn phí. Nếu bạn thấy nó hữu ích, hãy xem xét hỗ trợ bằng cách tặng một ⭐️ trên [GitHub](https://github.com/lehuygiang28/vnpay) và mua tác giả một cốc cà phê. -Buy Me A Coffee +Buy Me A Coffee ## Đóng góp diff --git a/README_en-US.md b/README_en-US.md index 88d3680..529f818 100644 --- a/README_en-US.md +++ b/README_en-US.md @@ -63,7 +63,7 @@ const vnpay = new VNPay({ #### `VNPay` is an open-source and free project. If you find it useful, please consider supporting it by starring ⭐️ the repository on [Github](https://github.com/lehuygiang28/vnpay) and buying me a coffee. -Buy Me A Coffee +Buy Me A Coffee ## Contribution