docs: Use vuepress instead

README.md

@@ -82,13 +82,13 @@ if err != nil {
 
 ## Services
 
-- [azblob](docs/services/azblob.md): [Azure Blob storage](https://docs.microsoft.com/en-us/azure/storage/blobs/)
-- [cos](docs/services/cos.md): [Tencent Cloud Object Storage](https://cloud.tencent.com/product/cos)
-- [dropbox](docs/services/dropbox.md): [Dropbox](https://www.dropbox.com)
-- [fs](docs/services/fs.md): Local file system
-- [gcs](docs/services/gcs.md): [Google Cloud Storage](https://cloud.google.com/storage/)
-- [kodo](docs/services/kodo.md): [qiniu kodo](https://www.qiniu.com/products/kodo)
-- [oss](docs/services/oss.md): [Aliyun Object Storage](https://www.aliyun.com/product/oss)
-- [qingstor](docs/services/qingstor.md): [QingStor Object Storage](https://www.qingcloud.com/products/qingstor/)
-- [s3](docs/services/s3.md): [Amazon S3](https://aws.amazon.com/s3/)
-- [uss](docs/services/uss.md): [UPYUN Storage Service](https://www.upyun.com/products/file-storage)
+- [azblob](./services/azblob/): [Azure Blob storage](https://docs.microsoft.com/en-us/azure/storage/blobs/)
+- [cos](./services/cos/): [Tencent Cloud Object Storage](https://cloud.tencent.com/product/cos)
+- [dropbox](./services/dropbox/): [Dropbox](https://www.dropbox.com)
+- [fs](./services/fs/): Local file system
+- [gcs](./services/gcs/): [Google Cloud Storage](https://cloud.google.com/storage/)
+- [kodo](./services/kodo/): [qiniu kodo](https://www.qiniu.com/products/kodo)
+- [oss](./services/oss/): [Aliyun Object Storage](https://www.aliyun.com/product/oss)
+- [qingstor](./services/qingstor/): [QingStor Object Storage](https://www.qingcloud.com/products/qingstor/)
+- [s3](./services/s3/): [Amazon S3](https://aws.amazon.com/s3/)
+- [uss](./services/uss/): [UPYUN Storage Service](https://www.upyun.com/products/file-storage)

docs/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.vuepress/dist/

docs/.vuepress/config.js

@@ -0,0 +1,18 @@
+module.exports = {
+    title: 'storage',
+    description: 'An application-oriented unified storage layer for Golang.',
+    smoothScroll: true,
+    sidebar: [
+        '/',
+        '/page-a',
+        ['/page-b', 'Explicit link text']
+    ],
+    themeConfig: {
+        nav: [
+            {text: 'Services', link: '/services/'},
+            {text: 'Design', link: '/design/'},
+            {text: 'Spec', link: '/spec/'}
+        ],
+        sidebar: "auto"
+    },
+}

docs/README.md

@@ -0,0 +1 @@
+../README.md

docs/design/README.md

@@ -0,0 +1,23 @@
+# Design
+
+## [1-unify-storager-behavior](./1-unify-storager-behavior/)
+## [2-use-callback-in-list-operations](./2-use-callback-in-list-operations.md)
+## [3-support-service-init-via-config-string](./3-support-service-init-via-config-string.md)
+## [4-credential-refactor](./4-credential-refactor.md)
+## [5-add-id-in-object](./5-add-id-in-object.md)
+## [6-normalize-metadata](./6-normalize-metadata.md)
+## [7-support-context](./7-support-context.md)
+## [8-normalize-metadata-storage-class](./8-normalize-metadata-storage-class.md)
+## [9-remove-storager-init](./9-remove-storager-init.md)
+## [10-callback-reader](./10-callback-reader.md)
+## [11-error-handling](./11-error-handling.md)
+## [12-support-both-directory-and-prefix-based-list](./12-support-both-directory-and-prefix-based-list.md)
+## [13-remove-config-string](./13-remove-config-string.md)
+## [14-normalize-content-hash-check](./14-normalize-content-hash-check.md)
+## [15-release-policy](./15-release-policy.md)
+## [16-loose-mode](./16-loose-mode.md)
+## [17-proposal-process](./17-proposal-process.md)
+## [18-return-segment-interface-instead](./18-return-segment-interface-instead.md)
+## [19-split-storage-list](./19-split-storage-list.md)
+## [20-remove-loose-mode](./20-remove-loose-mode.md)
+## [21-split-segmenter](./21-split-segmenter.md)

docs/package.json

@@ -0,0 +1,9 @@
+{
+  "devDependencies": {
+    "vuepress": "^1.4.1"
+  },
+  "scripts": {
+    "docs:dev": "vuepress dev .",
+    "docs:build": "vuepress build ."
+  }
+}

docs/services/README.md

@@ -0,0 +1,21 @@
+# Sevices
+
+## [azblob](./azblob/)
+
+## [cos](./cos/)
+
+## [dropbox](./dropbox/)
+
+## [fs](./fs/)
+
+## [gcs](./gcs/)
+
+## [kodo](./kodo/)
+
+## [oss](./oss/)
+
+## [qingstor](./qingstor/)
+
+## [s3](./s3/)
+
+## [uss](./uss/)

docs/spec/README.md

@@ -0,0 +1,5 @@
+# Spec
+
+## [1-error-handling](./1-error-handling/)
+
+## [2-proposal](./2-proposal/)