static site generator (#1)

* add vuepress * rename files * move images to the root dir * update image path * add config of vuepress * add travis
vechain · Oct 16, 2019 · a89bcb4 · a89bcb4
1 parent 310dd60
commit a89bcb4
Show file tree

Hide file tree

Showing 58 changed files with 10,257 additions and 74 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
 .DS_Store
+/.vscode/
+/node_modules/
+.vuepress/dist/
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,12 @@
+language: node_js
+node_js:
+  - "10"
+script:
+  - npm run docs:build
+deploy:
+  provider: pages
+  skip_cleanup: true
+  local_dir: .vuepress/dist/
+  github_token: $GH_TOKEN # Set in travis-ci.org dashboard
+  on:
+    branch: master
diff --git a/.vuepress/config.js b/.vuepress/config.js
@@ -0,0 +1,9 @@
+module.exports = {
+    configureWebpack: {
+        resolve: {
+            alias: {
+                '@public': '../public/'
+            }
+        }
+    }
+}
diff --git a/connex/Compatible client.md → connex/compatible-client.md b/connex/Compatible client.md → connex/compatible-client.md
diff --git a/connex/connex_intro.md → connex/connex-intro.md b/connex/connex_intro.md → connex/connex-intro.md
diff --git a/connex/Type.md → connex/type.md b/connex/Type.md → connex/type.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "thor-doc",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "docs:dev": "vuepress dev .",
+    "docs:build": "vuepress build ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vechain/doc.git"
+  },
+  "author": "jack.wu",
+  "license": "LGPL-3.0",
+  "bugs": {
+    "url": "https://github.com/vechain/doc/issues"
+  },
+  "homepagse": "https://github.com/vechain/doc#readme",
+  "devDependencies": {
+    "vuepress": "^1.2.0"
+  }
+}
diff --git a/sync/Images/activity-app.png → public/image/sync/activity-app.png b/sync/Images/activity-app.png → public/image/sync/activity-app.png
diff --git a/sync/Images/activity-insight.png → public/image/sync/activity-insight.png b/sync/Images/activity-insight.png → public/image/sync/activity-insight.png
diff --git a/sync/Images/activity.png → public/image/sync/activity.png b/sync/Images/activity.png → public/image/sync/activity.png
diff --git a/sync/Images/addShortcut.png → public/image/sync/add-shortcut.png b/sync/Images/addShortcut.png → public/image/sync/add-shortcut.png
diff --git a/sync/Images/addressBar.png → public/image/sync/address-bar.png b/sync/Images/addressBar.png → public/image/sync/address-bar.png
diff --git a/sync/Images/apps.png → public/image/sync/apps.png b/sync/Images/apps.png → public/image/sync/apps.png
diff --git a/sync/Images/cer-agreement.png → public/image/sync/cer-agreement.png b/sync/Images/cer-agreement.png → public/image/sync/cer-agreement.png
diff --git a/sync/Images/cer-identification.png → public/image/sync/cer-identification.png b/sync/Images/cer-identification.png → public/image/sync/cer-identification.png
diff --git a/sync/Images/certificate.png → public/image/sync/certificate.png b/sync/Images/certificate.png → public/image/sync/certificate.png
diff --git a/sync/Images/confirmed.png → public/image/sync/confirmed.png b/sync/Images/confirmed.png → public/image/sync/confirmed.png
diff --git a/sync/Images/confirming.png → public/image/sync/confirming.png b/sync/Images/confirming.png → public/image/sync/confirming.png
diff --git a/sync/Images/content-copy.png → public/image/sync/content-copy.png b/sync/Images/content-copy.png → public/image/sync/content-copy.png
diff --git a/sync/Images/edit.png → public/image/sync/edit.png b/sync/Images/edit.png → public/image/sync/edit.png
diff --git a/sync/Images/error.png → public/image/sync/error.png b/sync/Images/error.png → public/image/sync/error.png
diff --git a/sync/Images/homepage.png → public/image/sync/homepage.png b/sync/Images/homepage.png → public/image/sync/homepage.png
diff --git a/sync/Images/link.png → public/image/sync/link.png b/sync/Images/link.png → public/image/sync/link.png
diff --git a/sync/Images/menu.png → public/image/sync/menu.png b/sync/Images/menu.png → public/image/sync/menu.png
diff --git a/sync/Images/newTab.png → public/image/sync/new-tab.png b/sync/Images/newTab.png → public/image/sync/new-tab.png
diff --git a/sync/Images/outOfSync.png → public/image/sync/out-of-sync.png b/sync/Images/outOfSync.png → public/image/sync/out-of-sync.png
diff --git a/sync/Images/removeShortcut.png → public/image/sync/remove-shortcut.png b/sync/Images/removeShortcut.png → public/image/sync/remove-shortcut.png
diff --git a/sync/Images/retry.png → public/image/sync/retry.png b/sync/Images/retry.png → public/image/sync/retry.png
diff --git a/sync/Images/reverted.png → public/image/sync/reverted.png b/sync/Images/reverted.png → public/image/sync/reverted.png
diff --git a/sync/Images/sending.png → public/image/sync/sending.png b/sync/Images/sending.png → public/image/sync/sending.png
diff --git a/sync/Images/settings.png → public/image/sync/settings.png b/sync/Images/settings.png → public/image/sync/settings.png
diff --git a/sync/Images/Sync512.png → public/image/sync/sync-512.png b/sync/Images/Sync512.png → public/image/sync/sync-512.png
diff --git a/sync/Images/synced.png → public/image/sync/synced.png b/sync/Images/synced.png → public/image/sync/synced.png
diff --git a/sync/Images/syncing.png → public/image/sync/syncing.png b/sync/Images/syncing.png → public/image/sync/syncing.png
diff --git a/sync/Images/wallet-detail-activity.png → public/image/sync/wallet-detail-activity.png b/sync/Images/wallet-detail-activity.png → public/image/sync/wallet-detail-activity.png
diff --git a/sync/Images/wallets.png → public/image/sync/wallets.png b/sync/Images/wallets.png → public/image/sync/wallets.png
diff --git a/sync/Activities.md b/sync/Activities.md
diff --git a/sync/activities.md b/sync/activities.md
@@ -0,0 +1,42 @@
+You can check your signed transactions and certificates in Activities, you can also reveal the transaction in an DApp or Insight.
+
+##  Activities Overview
+### Activities Panel
+1. At top right ,click  <img src="~@public/image/sync/activity.png"  height = "20px" align=center /> or <img src="~@public/image/sync/sending.png"  height = "20px" align=center /> 
+2. The list will show all the signed transaction and certificates
+
+><img src="~@public/image/sync/sending.png"  height = "20px" align=center /> Means that the transaction is still in sending/confirming stage 
+
+### Wallet Detail Page
+1. On your computer, open Sync
+2. At top right, click <img src="~@public/image/sync/wallets.png" width = "16px" height = "16px" align=center /> , it will direct to wallet app
+3. Select the wallet 
+
+## Reverted Transaction  
+ When the transaction is reverted , it will be shown <img src="~@public/image/sync/reverted.png"  height = "20px" align=center /> next to transaction status.  There are many reasons may cause the transaction reverted. if the reverted is shown, please check the transaction you sent.
+
+## Transaction Status 
+There are 4 status of transaction :
+1. **Sending** <img src="~@public/image/sync/sending.png"  height = "20px" align=center />
+  : After signing a transaction , sync will send the signed transaction to node. if the transaction can not be send , you can click  <img src="~@public/image/sync/retry.png"  height = "20px" align=center /> to resend. 
+2. **Confirming** <img src="~@public/image/sync/confirming.png"  height = "20px" align=center /> : The transaction is confirming. stage.
+3. **Confirmed** <img src="~@public/image/sync/confirmed.png"  height = "20px" align=center /> : The transaction is confirmed.
+4. **Dropped** <img src="~@public/image/sync/error.png"  height = "20px" align=center />  :  The transaction is expired, can not be resend. 
+
+##  Reveal Transaction 
+1. **In Insight** 
+    1. At top right ,click  <img src="~@public/image/sync/activity.png"  height = "20px" align=center /> or <img src="~@public/image/sync/sending.png"  height = "20px" align=center />
+    2. Click the transaction which you would like to overview
+    3. Click transaction ID "<img src="~@public/image/sync/activity-app.png"  height = "20px" align=center />0x123456…123456"
+
+
+
+2. **In DApp**
+    1. At top right ,click  <img src="~@public/image/sync/activity.png"  height = "20px" align=center /> or <img src="~@public/image/sync/sending.png"  height = "20px" align=center />
+    2. Click the transaction which you would like to overview
+    3. Click "<img src="~@public/image/sync/activity-insight.png"  height = "20px" align=center />Domain"
+
+## Reveal Wallet 
+   1. At top right ,click  <img src="~@public/image/sync/activity.png"  height = "20px" align=center /> or <img src="~@public/image/sync/sending.png"  height = "20px" align=center />
+   2. Click the transaction which you would like to overview
+   3. Click Wallet's name 
diff --git a/sync/Browse DApp&Web.md → sync/browse-dapp-and-web.md b/sync/Browse DApp&Web.md → sync/browse-dapp-and-web.md
@@ -10,19 +10,19 @@ Sync is providing a seamless experience for users and developers ,it's easy to c
 
 ## Network Status 
  There are three colors show the network status : 
- 1.  **Green** <img src="Images/synced.png"  height = "16px" align=center /> :  The node is synced
- 2.   **Orange** <img src="Images/syncing.png"  height = "16px" align=center />: The node is  syncing 
- 3. **Red** <img src="Images/outOfSync.png"  height = "16px" align=center />:  The node is out of sync 
+ 1.  **Green** <img src="~@public/image/sync/synced.png"  height = "16px" align=center /> :  The node is synced
+ 2.   **Orange** <img src="~@public/image/sync/syncing.png"  height = "16px" align=center />: The node is  syncing 
+ 3. **Red** <img src="~@public/image/sync/out-of-sync.png"  height = "16px" align=center />:  The node is out of sync 
 
 ## Choose the Network and Node 
 ### Connect to Built-in Node
 1. Click on the network ,at left of the address bar(it shown the network MAIN/TEST/SOLO/UNKNOWN)
-![addressBa](Images/addressBar.png)
+![addressBa](~@public/image/sync/address-bar.png)
 
 2. Choose the network and node you would like to connect
 
 ### Add  Custom Node 
-1. At top right, click  <img src="Images/menu.png" width = "16px" height = "16px" align=center />
+1. At top right, click  <img src="~@public/image/sync/menu.png" width = "16px" height = "16px" align=center />
 2. Click **Settings** 
 3. Click **Add Node** on Nodes section
 4. Input the name which can help you to identity the node 
@@ -35,7 +35,7 @@ Sync is providing a seamless experience for users and developers ,it's easy to c
 
 ### Edit  Custom Node's Name
 
-1. At top right, click  <img src="Images/menu.png" width = "16px" height = "16px" align=center />
+1. At top right, click  <img src="~@public/image/sync/menu.png" width = "16px" height = "16px" align=center />
 2. Click **Settings** 
 3. Click **Add Node** on Nodes section
 4. Click **EDIT** 
@@ -44,38 +44,38 @@ Sync is providing a seamless experience for users and developers ,it's easy to c
 
 ### Delete  Custom Node
 
-1. At top right, click  <img src="Images/menu.png" width = "16px" height = "16px" align=center />
+1. At top right, click  <img src="~@public/image/sync/menu.png" width = "16px" height = "16px" align=center />
 2. Click **Settings** 
 3. Click  **Add Node** on Nodes section
 4. Click **EDIT** 
 5. Click **DELETE**
 
 ## Go to DApps or Websites
 1. At the top center, input the website/DAppS name or URL in the address bar
-![addressBa](Images/addressBar.png)
+![addressBa](~@public/image/sync/address-bar.png)
 2. Pick a suggestion/recently visited, or press Return/Enter to go directly to the address you typed.
 
 ## Open New Tab 
-At the top of the window, next to the last tab on the right, click <img src="Images/newTab.png" width = "16px" height = "16px" align=center /> to open new tab
+At the top of the window, next to the last tab on the right, click <img src="~@public/image/sync/new-tab.png" width = "16px" height = "16px" align=center /> to open new tab
 
 ## Shortcuts  
 *  Add new shortcut 
-    1. At right of the address bar , Click <img src="Images/addShortcut.png"  height = "20px" align=center />
+    1. At right of the address bar , Click <img src="~@public/image/sync/add-shortcut.png"  height = "20px" align=center />
 
-    2. Click <img src="Images/addShortcut.png"  height = "20px" align=center />**Add shortcut**" to confirm.If you want to dismiss the action, you can click anywhere to cancel the action
+    2. Click <img src="~@public/image/sync/add-shortcut.png"  height = "20px" align=center />**Add shortcut**" to confirm.If you want to dismiss the action, you can click anywhere to cancel the action
 
 * Remove shortcut
     1. In DApp/website
-        1. At right of the address bar , Click <img src="Images/removeShortcut.png"  height = "20px" align=center />
-        2. Click <img src="Images/removeShortcut.png"  height = "20px" align=center />**Remove shortcut**" to confirm.If you want to cancel, you can click anywhere to cancel the action
+        1. At right of the address bar , Click <img src="~@public/image/sync/remove-shortcut.png"  height = "20px" align=center />
+        2. Click <img src="~@public/image/sync/remove-shortcut.png"  height = "20px" align=center />**Remove shortcut**" to confirm.If you want to cancel, you can click anywhere to cancel the action
 
     2. In homepage
         1. Move-over your pointer to the shortcut which you want to remove and wait for a second.
-        2. Click the <img src="Images/edit.png"  height = "20px" align=center /> at top right 
+        2. Click the <img src="~@public/image/sync/edit.png"  height = "20px" align=center /> at top right 
         3. Click **REMOVE**
 
 * Edit shortcut's name
      1. Move-over your pointer to the shortcut which you want to edit
-     2. Click the <img src="Images/edit.png"  height = "20px" align=center /> at top right 
+     2. Click the <img src="~@public/image/sync/edit.png"  height = "20px" align=center /> at top right 
      3. Input the name which you would like to name the shortcut
      4. Click **SAVE** to finished the editing.
diff --git a/sync/Contributing.md → sync/contributing.md b/sync/Contributing.md → sync/contributing.md
diff --git a/sync/Download & Install.md → sync/download-and-install.md b/sync/Download & Install.md → sync/download-and-install.md
diff --git a/sync/FAQ.md → sync/faq.md b/sync/FAQ.md → sync/faq.md
@@ -47,5 +47,5 @@ On other hands, the certificate of agreement is a certificate that you agree to
 3. Click "**Inspect Element**"
 
 ### Web Content
-1. At upper right, Click <img src="Images/menu.png"  height = "20px" align=center />
+1. At upper right, Click <img src="~@public/image/sync/menu.png"  height = "20px" align=center />
 2. Click"**Toggle Developer Tools**"
diff --git a/sync/Interact with DApps.md → sync/interact-with-dapps.md b/sync/Interact with DApps.md → sync/interact-with-dapps.md
@@ -17,7 +17,7 @@ On the left side, it shows the transaction summary; number of clauses; the descr
 ## Signing a Certificate
 The certificate is a message signing based mechanism which can easily provide your identification or you to agree to your terms or agreements to the DApp.
 
-1. Check the type of certificate(<img src="Images/cer-identification.png"  height = "20px" align=center /> / <img src="Images/cer-agreement.png"  height = "20px" align=center />)
+1. Check the type of certificate(<img src="~@public/image/sync/cer-identification.png"  height = "20px" align=center /> / <img src="~@public/image/sync/cer-agreement.png"  height = "20px" align=center />)
 2. Review the content 
 3. Choose a wallet to sign the certificate
 4. Input wallet's password

diff --git a/sync/Report Issue.md → sync/report-issue.md b/sync/Report Issue.md → sync/report-issue.md
diff --git a/sync/Settings.md → sync/settings.md b/sync/Settings.md → sync/settings.md
@@ -1,17 +1,17 @@
 ## Dark Theme
-1. At top right, click  <img src="Images/menu.png" width = "16px" height = "16px" align=center />
+1. At top right, click  <img src="~@public/image/sync/menu.png" width = "16px" height = "16px" align=center />
 2. Click  **Settings**
 3. Click switch button to enable or disable the dark theme 
 
 ## Update
 Sync releases updates from time to time. Install the update version for feature, security fixes and improved software  stability.Sync can automatically update when a new version is release. 
 ### Sync Version
-1. At top right, click  <img src="Images/menu.png" width = "16px" height = "16px" align=center />
+1. At top right, click  <img src="~@public/image/sync/menu.png" width = "16px" height = "16px" align=center />
 2. Click **About** / **Settings**
 
 
 ### Check Update Manually 
-1. At top right, click  <img src="Images/menu.png" width = "16px" height = "16px" align=center />
+1. At top right, click  <img src="~@public/image/sync/menu.png" width = "16px" height = "16px" align=center />
 2. Click **Settings**
 3. In **Auto Update** section, Click **CHECK** at the right side
 4. If there is a new released, it will automatically download the latest version

diff --git a/sync/Wallet.md → sync/wallet.md b/sync/Wallet.md → sync/wallet.md
@@ -1,6 +1,6 @@
 ## Create  Wallet
 1. On your computer, open Sync
-2. At top right, click <img src="Images/wallets.png" width = "16px" height = "16px" align=center /> , it will direct to wallet app
+2. At top right, click <img src="~@public/image/sync/wallets.png" width = "16px" height = "16px" align=center /> , it will direct to wallet app
 3. At the top, click **New** 
 4. Fill in fields to create your wallet 
 5. Write down the mnemonic words
@@ -13,7 +13,7 @@ Reference Article :
 
 ## Import Wallet 
 1. On your computer, open Sync
-2. At top right, click <img src="Images/wallets.png" width = "16px" height = "16px" align=center /> , it will direct to wallet app
+2. At top right, click <img src="~@public/image/sync/wallets.png" width = "16px" height = "16px" align=center /> , it will direct to wallet app
 3. At the top, click **Import** 
 4. Select a method to import(Only keystore need to enter the keystore password)
 5. Once the information verified, you can fill in fields to import your wallet 
@@ -24,7 +24,7 @@ The mnemonic words/keystore stores all the information that is needed at any poi
 
 ### Export Keystore
 1. On your computer, open Sync
-2. At top right, click <img src="Images/wallets.png" width = "16px" height = "16px" align=center />  , it will direct to wallet app
+2. At top right, click <img src="~@public/image/sync/wallets.png" width = "16px" height = "16px" align=center />  , it will direct to wallet app
 3. Click the wallet you which needs to export the key store
 4. Click **Backup**
 5. Enter the wallet password to continue process 
@@ -33,39 +33,39 @@ The mnemonic words/keystore stores all the information that is needed at any poi
 ### Reset Password 
 You can change your wallet's name and password after wallet's password verified. 
 1. On your computer, open Sync
-2. At top right, click <img src="Images/wallets.png" width = "16px" height = "16px" align=center />  , it will direct to wallet app
+2. At top right, click <img src="~@public/image/sync/wallets.png" width = "16px" height = "16px" align=center />  , it will direct to wallet app
 3. Click the wallet you which needs to change the password
 4. Click **Reset Password**
 5. Enter the wallet password to continue process
 6. Enter New password and click save
 
 ### Wallet Recovery
 1. On your computer, open Sync
-2. At top right, click <img src="Images/wallets.png" width = "16px" height = "16px" align=center /> , it will direct to wallet app
+2. At top right, click <img src="~@public/image/sync/wallets.png" width = "16px" height = "16px" align=center /> , it will direct to wallet app
 3. At the top, click **Import** 
 4. Select a method to import(Only keystore need to enter the keystore password)
 5. Once the information verified, you can fill in fields to import your wallet 
 
 > If the wallet already existed, please checked the box to reset the wallet 
 
 ## Wallet Activity
-![activity](Images/wallet-detail-activity.png)
+![activity](~@public/image/sync/wallet-detail-activity.png)
 
 ### Transaction
 - Date : Show the date which you signed the transaction.
 - Status : There are 4 status of a transaction
-    1. **Sending** <img src="Images/sending.png"  height = "20px" align=center />
-  : After signing a transaction , sync will send the signed transaction to node. if the transaction can not be send , you can click  <img src="Images/retry.png"  height = "20px" align=center /> to resend. 
-    2. **Confirming** <img src="Images/confirming.png"  height = "20px" align=center /> : The transaction is confirming. stage.
-    3. **Confirmed** <img src="Images/confirmed.png"  height = "20px" align=center /> : The transaction is confirmed.
-    4. **Dropped** <img src="Images/error.png"  height = "20px" align=center />  :  The transaction is expired, can not be resend. 
+    1. **Sending** <img src="~@public/image/sync/sending.png"  height = "20px" align=center />
+  : After signing a transaction , sync will send the signed transaction to node. if the transaction can not be send , you can click  <img src="~@public/image/sync/retry.png"  height = "20px" align=center /> to resend. 
+    2. **Confirming** <img src="~@public/image/sync/confirming.png"  height = "20px" align=center /> : The transaction is confirming. stage.
+    3. **Confirmed** <img src="~@public/image/sync/confirmed.png"  height = "20px" align=center /> : The transaction is confirmed.
+    4. **Dropped** <img src="~@public/image/sync/error.png"  height = "20px" align=center />  :  The transaction is expired, can not be resend. 
 - Type: Transfer / Call / Create
 - Link : Application URL.
 - Action : Reveal transaction in insight.
 
 ### Certificate
 - Date : Show the date which you signed the transaction.
-- status : Always <img src="Images/confirmed.png"  height = "20px" align=center /> (Only signed certificate will be record.)
+- status : Always <img src="~@public/image/sync/confirmed.png"  height = "20px" align=center /> (Only signed certificate will be record.)
 - Type : Identification / Agreement 
 - Link : Application URL.
 - Action : Show the signed content.
diff --git a/thor/Block.md → thor/block.md b/thor/Block.md → thor/block.md
diff --git a/thor/Built-in Contracts.md → thor/builtin-contracts.md b/thor/Built-in Contracts.md → thor/builtin-contracts.md
diff --git a/thor/Custom network.md → thor/custom-network.md b/thor/Custom network.md → thor/custom-network.md
diff --git a/thor/FAQ.md → thor/faq.md b/thor/FAQ.md → thor/faq.md
diff --git a/thor/fee delegation.md → thor/fee-delegation.md b/thor/fee delegation.md → thor/fee-delegation.md
diff --git a/thor/Proof of Authority.md → thor/proof-of-authority.md b/thor/Proof of Authority.md → thor/proof-of-authority.md
diff --git a/thor/transaction calculation.md → thor/transaction-calculation.md b/thor/transaction calculation.md → thor/transaction-calculation.md
diff --git a/thor/transaction model.md → thor/transaction-model.md b/thor/transaction model.md → thor/transaction-model.md
diff --git a/thor/two-token design.md → thor/two-token-design.md b/thor/two-token design.md → thor/two-token-design.md
diff --git a/tutorials/Designated Fee Delegation.md → tutorials/designated-fee-delegation.md b/tutorials/Designated Fee Delegation.md → tutorials/designated-fee-delegation.md
diff --git a/tutorials/Forcible Transaction Dependency.md → tutorials/forcible-transaction-dependency.md b/tutorials/Forcible Transaction Dependency.md → tutorials/forcible-transaction-dependency.md