Merge pull request #11 from lehuygiang28/update_docs

Update VNPay documentation and badges
lehuygiang28 · May 22, 2024 · 876ace2 · 876ace2
2 parents 67f6188 + e0d3f6e
commit 876ace2
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# vnpay
+# VNPay Lib
 
 <div style="text-align: center;">
     <h5>
@@ -9,6 +9,12 @@
 </div>
 <br/>
 
+<p align="center">
+<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/v/vnpay" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/l/vnpay" alt="Package License"><a>
+<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/dm/vnpay" alt="NPM Downloads"></a>
+</p>
+
 <strong>Thư viện mã nguồn mở hỗ trợ thanh toán qua [VNPay](https://vnpay.vn).</strong>
 
 ## Tài liệu
@@ -57,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ê.
 
-<a href="https://www.buymeacoffee.com/lehuygiang28" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
+<a href="https://www.buymeacoffee.com/lehuygiang28" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
 
 ## Đóng góp
 

diff --git a/README_en-US.md b/README_en-US.md
@@ -1,4 +1,4 @@
-# VNPay API Nodejs
+# VNPay Lib
 
 <div style="text-align: center;">
     <h5>
@@ -9,6 +9,12 @@
 </div>
 <br/>
 
+<p align="center">
+<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/v/vnpay" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/l/vnpay" alt="Package License"><a>
+<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/dm/vnpay" alt="NPM Downloads"></a>
+</p>
+
 <strong>An open-source library support to payment with [VNPay](https://vnpay.vn).</strong>
 
 ## Documentations
@@ -57,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.
 
-<a href="https://www.buymeacoffee.com/lehuygiang28" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
+<a href="https://www.buymeacoffee.com/lehuygiang28" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
 
 ## Contribution
 

diff --git 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 
+            <a target="_blank" rel="noopener noreferrer" href="https://github.com/lehuygiang28/vnpay/issues/9">this issue on GitHub</a>.
+        `,
+            backgroundColor: '#fafbfc',
+            textColor: '#091E42',
+            isCloseable: true,
+        },
     } satisfies Preset.ThemeConfig,
     plugins: [
         [