Merge branch 'master' into master

Author: zdying

_config.yml

@@ -1,4 +1,4 @@
-title: hiproxy
+title: hiproxy documentation
 subtitle: "A lightweight and powerful proxy tool for front-end developer based on Node.js."
 description: "hiproxy is a lightweight proxy tool for Front-End developers based on Node.js that supports an NGINX-like configuration."
 author: hiproxy

db.json

@@ -8,7 +8,7 @@
   "scripts": {
     "build": "rm -rdf public && hexo generate",
     "eslint": "eslint .",
-    "deploy": "hexo deploy"
+    "deploy": "npm run build && hexo deploy"
   },
   "dependencies": {
     "hexo": "^3.3.9",
@@ -20,7 +20,8 @@
     "hexo-renderer-marked": "^0.2.10",
     "hexo-renderer-stylus": "^0.3.1",
     "hexo-server": "^0.2.0",
-    "lodash": "^4.5.1"
+    "lodash": "^4.5.1",
+    "lunr": "^2.1.3"
   },
   "devDependencies": {}
 }

package.json

@@ -1 +1 @@
-hiproxy.js.org
+hiproxy.org

source/CNAME

@@ -7,10 +7,10 @@ en:
     Project Code: https://github.com/hiproxy/hiproxy
     Docmentation Code: https://github.com/hiproxy/documentation
   libs:
-    hemsl: https://github.com/hemsl/hemsl
-    step-flow: https://github.com/hiproxy/step-flow
-    conf-parser: https://github.com/hiproxy/conf-parser
-    open-browser: https://github.com/hiproxy/open-browser
+    hemsl/hemsl: https://github.com/hemsl/hemsl
+    hiproxy/step-flow: https://github.com/hiproxy/step-flow
+    hiproxy/conf-parser: https://github.com/hiproxy/conf-parser
+    hiproxy/open-browser: https://github.com/hiproxy/open-browser
   links:
     qfight: https://github.com/qfight
     YMFE: http://ued.qunar.com/ymfe/about
@@ -26,10 +26,10 @@ zh-cn:
     项目源码: https://github.com/hiproxy/hiproxy
     文档源码: https://github.com/hiproxy/documentation
   libs:
-    hemsl: https://github.com/hemsl/hemsl
-    step-flow: https://github.com/hiproxy/step-flow
-    conf-parser: https://github.com/hiproxy/conf-parser
-    open-browser: https://github.com/hiproxy/open-browser
+    hemsl/hemsl: https://github.com/hemsl/hemsl
+    hiproxy/step-flow: https://github.com/hiproxy/step-flow
+    hiproxy/conf-parser: https://github.com/hiproxy/conf-parser
+    hiproxy/open-browser: https://github.com/hiproxy/open-browser
   links:
     qfight: https://github.com/qfight
     YMFE: http://ued.qunar.com/ymfe/about

source/_data/footerlinks.yml

@@ -19,7 +19,7 @@ You can get the URL from <http://127.0.0.1:5525/> by following below image:
 
 The following describes how the root certificate is installed in OSX, iOS, Windows and Android.
 
-### OSX System
+### Mac OSX
 
 1. Double click downloaded `Hiproxy_Custom_CA_Certificate.pem` to import the certificate to keychain.
 
@@ -38,7 +38,7 @@ The following describes how the root certificate is installed in OSX, iOS, Windo
 <img src="../../images/root_cert_trusted.png" width="680" />
 
 
-### iOS系统
+### iOS
 
 1. Send the downloaded certificate to iPhone then open it in iOS.
 

source/configuration/ssl_certificate.md

@@ -1,4 +1,5 @@
 title: CLI Command
+---
 
 > If you are willing to help hiproxy to write documentation, please contact zdying@live.com, thank you!
 

source/developers/cli_command.md

@@ -1,35 +1,35 @@
 
 layout: index
 description: hiproxy is a lightweight proxy tool for Front-End developers based on Node.js that supports an NGINX-like configuration.
-subtitle: A lightweight proxy tool for Front-End developers based on Node.js
+subtitle: Lightweight & Extensible Proxy Base on Node.js
 comments: false
 ---
 ul#intro-feature-list
   li.intro-feature-wrap
     .intro-feature
       .intro-feature-icon
         i.fa.fa-bolt
-      h3.intro-feature-title Lightweight and Extensible
+      h3.intro-feature-title Lightweight & Extensible
       p.intro-feature-desc
-        | hiproxy dependence on fewer libraries so you can install it quickly, developers can extend hiproxy to support with commands, instructions, and pages.
+        | Hiproxy is a lightweight proxy with few dependencies, quick installing, as well as extensible on commands and pages.
   li.intro-feature-wrap
     .intro-feature
       .intro-feature-icon
         i.fa.fa-cog
-      h3.intro-feature-title Reuse Existing Development Habits
+      h3.intro-feature-title Keep Your Habits
       p.intro-feature-desc
-        | Using hosts and Nginx style configuration, reuse the development, configuration habits. It's easy to learn and use.
+        | Keep used to configure in <strong>hosts</strong> or <strong>Nginx</strong> style. Easy to learn, and keep relax in using.
   li.intro-feature-wrap
     .intro-feature
       .intro-feature-icon
         i.fa.fa-lock
-      h3.intro-feature-title HTTPS Certificate Automatically Generate and Manage
+      h3.intro-feature-title Generate Certificate Automatically
       p.intro-feature-desc
-        | hiproxy can generate root certificate and automatically generate the domain certificate.
+        | Hiproxy can play the CA role with generated root certificate by itself. It can also generate certificates for each requesting domains.
   li.intro-feature-wrap
     .intro-feature
       .intro-feature-icon
         i.fa.fa-chrome
-      h3.intro-feature-title Highly Integrated With the Browser
+      h3.intro-feature-title Highly Integrated with Browsers
       p.intro-feature-desc
-        | hiproxy will open a new browser window and automatically configure the agent for you.
+        | While hiproxy starts, it opens a new browser window and configure its proxy automatically. Such you would feel free.

source/index.jade

@@ -165,13 +165,13 @@ They are valid only in then same domain and make directives ignored which has th
 
 Description: specify certificate file
 
-parameter: **ssl_certificate** file.crt（It must be relative path, and would be improve in the furture.）
+parameter: **ssl_certificate** file.crt
 
 Example:
 
 ```bash
 example.com => {
-    ssl_certificate /user/root/.hiproxy/cert/example.crt;
+  ssl_certificate /user/root/.hiproxy/cert/example.crt;
 }
 
 ```
@@ -180,13 +180,13 @@ example.com => {
 
 Description: specify the file storing private key
 
-parameter: **ssl_certificate_key** file.key（It must be relative path, and would be improve in the furture.）
+parameter: **ssl_certificate_key** file.key
 
 Example:
 
 ```bash
 example.com => {
-    ssl_certificate_key /user/root/.hiproxy/cert/example.key;
+  ssl_certificate_key /user/root/.hiproxy/cert/example.key;
 }
 
 ```

source/rewrite/directive.md

@@ -36,7 +36,7 @@ $var_name
 
 ```bash
 [domain_name|variable] => {
-    # ...
+  # ...
 }
 ```
 **Example**
@@ -46,12 +46,12 @@ set $domain some.example.com
 
 # use a domain name directly
 some.example.com => {
-    # ...
+  # ...
 }
 
 # or use a variable
 $domain => {
-    # ...
+  # ...
 }
 ```
 ### location
@@ -64,30 +64,30 @@ $domain => {
 
 ```bash
 location [directory|file|regex|variables] {
-    # ...
+  # ...
 }
 ```
 **Example**
 
 ```bash
 # directory
 location /some/path/ {
-    # ...
+  # ...
 }
 
 # specific file
 location /some/file.htm {
-    # ...
+  # ...
 }
 
 # regular expression
 location ~ ^/some/(path|path1)/.* {
-    # ...
+  # ...
 }
 
 # variables
 location $some/$path {
-    # ...
+  # ...
 }
 ```
 ### Directives
@@ -127,7 +127,7 @@ The brief syntax can define some basic rules, no need `location` or other direct
 **Syntax**
 
 ```bash
-domain ==> domain|path
+domain => domain|path
 ```
 
 **Example**
@@ -149,32 +149,32 @@ api.hiproxy.org/mock => $local/mock;
 ```bash
 # rewrite folder
 api.hiproxy.org/user/ => {
-    proxy_pass local.hiproxy.org/user/;
+  proxy_pass local.hiproxy.org/user/;
 
-    # proxy request config
-    proxy_set_header Host api.hiproxy.org;
-    proxy_set_header other value;
-    proxy_hide_header other;
+  # proxy request config
+  proxy_set_header Host api.hiproxy.org;
+  proxy_set_header other value;
+  proxy_hide_header other;
+  
+  proxy_set_cookie userid 20150910121359;
+  proxy_hide_cookie sessionid;
 
-    proxy_set_cookie userid 20150910121359;
-    proxy_hide_cookie sessionid;
+  # response config
+  set_cookie sessionID E3BF86A90ACDD6C5FF49ACB09;
+  set_header proxy hiproxy;
 
-    # response config
-    set_cookie sessionID E3BF86A90ACDD6C5FF49ACB09;
-    set_header proxy hiproxy;
+  # allow CORS
+  set_header Access-Control-Allow-Origin *;
 
-    # allow CORS
-    set_header Access-Control-Allow-Origin *;
-
-    hide_header proxy;
-    hide_cookie sessionID;
+  hide_header proxy;
+  hide_cookie sessionID;
 }
 ```
 
 ```bash
 # regexp support
 ~ /(demo|example)/([^\/]*\.(html|htm))$ => {
-   proxy_pass http://127.0.0.1:9999/$1/src/$2;
+  proxy_pass http://127.0.0.1:9999/$1/src/$2;
 }
 ```
 
@@ -187,55 +187,53 @@ set $id 1234567;
 
 # standard rewrite url
 $domain => {
-    proxy_pass http://$local/api/mock/;
-    set $id 1234;
-    set $mock_user user_$id;
-    set_header Host $domain;
-    set_header UserID $mock_user;
-    set_header Access-Control-Allow-Origin *;
+  proxy_pass http://$local/api/mock/;
+  set $id 1234;
+  set $mock_user user_$id;
+  set_header Host $domain;
+  set_header UserID $mock_user;
+  set_header Access-Control-Allow-Origin *;
 }
 
 blog.hiproxy.org => {
-    set_header Access-Control-Allow-Origin *;
-
-    set $node_server 127.0.0.1:3008;
-    set $order order;
-    set $cookie1 login=true;expires=20160909;
-
-    location /$api/$order/detail {
-        proxy_pass http://$node_server/user/?domain=$domain;
-        set_header Set-Cookie userID 200908204140;
-    }
-
-    location ~ /(usercenter|userinfo)/ {
-        set $cookie login=true;expires=20180808;
-        set $id 56789;
-
-        proxy_pass http://127.0.0.1:3008/info/;
-
-        set_cookie userID 200908204140;
-        set_cookie userName user_$id;
-    }
-
-    location ~ /local\/(.*)(\?(.*))? {
-        send_file ./mock/$1.json;
-    }
-
-    location /dev {
-        #alias /site/path/;
-        alias ./src/view/;
-        root app.html
-    }
-
-    location /multiple {
-        echo <h1>hello_echo</h1>;
-        echo <p>test echo directive</p>;
-        echo <p>finish</p>;
-    }
-
+  set_header Access-Control-Allow-Origin *;
+
+  set $node_server 127.0.0.1:3008;
+  set $order order;
+  set $cookie1 login=true;expires=20160909;
+
+  location /$api/$order/detail {
+    proxy_pass http://$node_server/user/?domain=$domain;
+    set_header Set-Cookie userID 200908204140;
+  }
+
+  location ~ /(usercenter|userinfo)/ {
+    set $cookie login=true;expires=20180808;
+    set $id 56789;
+
+    proxy_pass http://127.0.0.1:3008/info/;
+
+    set_cookie userID 200908204140;
+    set_cookie userName user_$id;
+  }
+
+  location ~ /local/(.*)(\?(.*))? {
+    send_file ./mock/$1.json;
+  }
+
+  location /dev {
+    #alias /site/path/;
+    alias ./src/view/;
+    root app.html
+  }
+
+  location /multiple {
+    echo <h1>hello_echo</h1>;
+    echo <p>test echo directive</p>;
+    echo <p>finish</p>;
+  }
 }
 ```
 
-
 [hosts]: ../configuration/hosts.html
 [Nginx]: http://nginx.org/en/docs/