📝 docs: Write some documents

Signed-off-by: sqrtthree <[email protected]>
linhe0x0 · May 24, 2018 · 4b15211 · 4b15211
1 parent ce4ac03
commit 4b15211
Show file tree

Hide file tree

Showing 22 changed files with 761 additions and 0 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -0,0 +1,20 @@
+module.exports = {
+  title: 'Hello, World.',
+  description: '📦 🎨 A api-friendly theme for VuePress.',
+  theme: 'api',
+  base: '/vuepress-theme-api/',
+  locales: {
+    '/': {
+      lang: 'en-US',
+      title: 'Hello, World.',
+      text: 'english',
+      description: '📦 🎨 A api-friendly theme for VuePress.',
+    },
+    '/zh/': {
+      lang: 'zh-hans',
+      title: 'Hello, World.',
+      text: '中文',
+      description: '📦 🎨 一个面向 RESTful API 设计的开箱即用主题。',
+    },
+  },
+}
diff --git a/docs/.vuepress/dist/404.html b/docs/.vuepress/dist/404.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>VuePress</title>
+    <meta name="description" content="">
+
+
+    <link rel="preload" href="/assets/css/4.styles.a4d6186c.css" as="style"><link rel="preload" href="/assets/js/app.6988c9c6.js" as="script"><link rel="prefetch" href="/assets/js/0.15a368a1.js"><link rel="prefetch" href="/assets/js/1.1d8a9ed7.js"><link rel="prefetch" href="/assets/js/2.e138d13a.js"><link rel="prefetch" href="/assets/js/3.7528a031.js">
+    <link rel="stylesheet" href="/assets/css/4.styles.a4d6186c.css">
+  </head>
+  <body>
+    <div id="app" data-server-rendered="true"><div class="theme-container"><div class="content"><h1>404</h1><blockquote>There's nothing here.</blockquote></div></div></div>
+    <script src="/assets/js/app.6988c9c6.js" defer></script>
+  </body>
+</html>
diff --git a/docs/.vuepress/dist/assets/css/4.styles.a4d6186c.css b/docs/.vuepress/dist/assets/css/4.styles.a4d6186c.css
diff --git a/docs/.vuepress/dist/assets/js/0.15a368a1.js b/docs/.vuepress/dist/assets/js/0.15a368a1.js
diff --git a/docs/.vuepress/dist/assets/js/1.1d8a9ed7.js b/docs/.vuepress/dist/assets/js/1.1d8a9ed7.js
diff --git a/docs/.vuepress/dist/assets/js/2.e138d13a.js b/docs/.vuepress/dist/assets/js/2.e138d13a.js
diff --git a/docs/.vuepress/dist/assets/js/3.7528a031.js b/docs/.vuepress/dist/assets/js/3.7528a031.js
diff --git a/docs/.vuepress/dist/assets/js/app.6988c9c6.js b/docs/.vuepress/dist/assets/js/app.6988c9c6.js
diff --git a/docs/.vuepress/dist/favicon.ico b/docs/.vuepress/dist/favicon.ico
diff --git a/docs/.vuepress/dist/getting-started/index.html b/docs/.vuepress/dist/getting-started/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Hello, World. | Getting Started</title>
+    <meta name="description" content="📦 🎨 A api-friendly theme for VuePress.">
+
+
+    <link rel="preload" href="/assets/css/4.styles.a4d6186c.css" as="style"><link rel="preload" href="/assets/js/app.6988c9c6.js" as="script"><link rel="preload" href="/assets/js/2.e138d13a.js" as="script"><link rel="prefetch" href="/assets/js/0.15a368a1.js"><link rel="prefetch" href="/assets/js/1.1d8a9ed7.js"><link rel="prefetch" href="/assets/js/3.7528a031.js">
+    <link rel="stylesheet" href="/assets/css/4.styles.a4d6186c.css">
+  </head>
+  <body>
+    <div id="app" data-server-rendered="true"><div class="theme__container sidebar-open"><div class="row"><div class="col-md-2"><div class="sidebar"><div class="group"><div class="group__title">Other Language</div><div class="group__body"><!----><div name="/" class="group__category category"><div class="category__label"><a href="/" class="router-link-active">English</a></div></div><div name="/zh/" class="group__category category"><div class="category__label"><a href="/zh/">中文</a></div></div></div></div><div class="group"><div class="group__title">Home</div><div class="group__body"><div class="group__category category"><div class="category__label"><a href="/" class="router-link-active">Homepage</a></div></div></div></div><div class="group"><div class="group__title">getting-started</div><div class="group__body"><div class="group__category category category--selected category--active"><div class="category__label"><a href="/getting-started/" class="router-link-exact-active router-link-active">Getting Started</a></div></div><div class="group__category category"><div class="category__label"><a href="/getting-started/#aha">Aha</a></div></div></div></div></div></div><div class="col-md-10"><div class="page__container"><div class="content custom"><h1 id="getting-started"><a href="#getting-started" aria-hidden="true" class="header-anchor">#</a> Getting Started</h1><h2 id="aha"><a href="#aha" aria-hidden="true" class="header-anchor">#</a> aha</h2><p>this is a title.</p></div></div></div></div></div></div>
+    <script src="/assets/js/2.e138d13a.js" defer></script><script src="/assets/js/app.6988c9c6.js" defer></script>
+  </body>
+</html>
diff --git a/docs/.vuepress/dist/index.html b/docs/.vuepress/dist/index.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Hello, World.</title>
+    <meta name="description" content="Not sure where to start? We’ve put together some handy guides and reference documentation you can use to start building.">
+
+
+    <link rel="preload" href="/assets/css/4.styles.a4d6186c.css" as="style"><link rel="preload" href="/assets/js/app.6988c9c6.js" as="script"><link rel="preload" href="/assets/js/3.7528a031.js" as="script"><link rel="prefetch" href="/assets/js/0.15a368a1.js"><link rel="prefetch" href="/assets/js/1.1d8a9ed7.js"><link rel="prefetch" href="/assets/js/2.e138d13a.js">
+    <link rel="stylesheet" href="/assets/css/4.styles.a4d6186c.css">
+  </head>
+  <body>
+    <div id="app" data-server-rendered="true"><div class="theme__container no-sidebar"><div><div class="home__container container"><div class="home__header"><h1 class="home__title">Hello, World.</h1><p class="home__description">Not sure where to start? We’ve put together some handy guides and reference documentation you can use to start building.</p><a href="/getting-started" class="btn btn--default btn--default">Getting Started</a></div><div class="home__body row"><div class="home__content col-md-10"><div class="content custom"><h3 id="as-easy-as-1-2-3"><a href="#as-easy-as-1-2-3" aria-hidden="true" class="header-anchor">#</a> As Easy as 1, 2, 3</h3><pre class="language-bash"><code><span class="token comment"># install vuepress</span>
+yarn global add vuepress <span class="token comment"># OR npm install -g vuepress</span>
+
+<span class="token comment"># install theme</span>
+yarn global add vuepress-theme-api <span class="token comment"># OR npm install -g vuepress-theme-api</span>
+
+<span class="token comment"># create a markdown file and write something</span>
+<span class="token keyword">echo</span> <span class="token string">'# Hello, World.'</span> <span class="token operator">&gt;</span> Hello.md
+
+<span class="token comment"># start writing</span>
+vuepress dev
+
+<span class="token comment"># build to static files</span>
+vuepress build
+</code></pre><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>VuePress requires <a href="http://nodejs.org/" target="_blank" rel="noopener noreferrer">Node.js</a> &gt;= 8.</p></div><section class="section section--dark section--center"><div class="container"><div class="row enhance-mode__homepage"><div class="col-md-10"><h2 id="build-for-restful-api"><a href="#build-for-restful-api" aria-hidden="true" class="header-anchor">#</a> Build for RESTful API</h2><p>A easy-to-use, minimalist theme for vuepress.</p><p>With out-of-the-box feature, all you need to do is install it and write something.</p><br><a href="/getting-started/" class="btn btn--light btn--default">Getting Started</a></div></div></div></section></div></div></div><footer class="home__footer"><p>Open Source on <a href="https://github.com/sqrthree/vuepress-theme-api">GitHub</a>, Made by <a href="https://github.com/sqrthree">@sqrthree</a>, Power by <a href="https://github.com/vuejs/vuepress">vuepress</a>.</p>
+</footer></div></div></div></div>
+    <script src="/assets/js/3.7528a031.js" defer></script><script src="/assets/js/app.6988c9c6.js" defer></script>
+  </body>
+</html>
diff --git a/docs/.vuepress/dist/zh/getting-started/index.html b/docs/.vuepress/dist/zh/getting-started/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="zh-hans">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Hello, World. | 起步</title>
+    <meta name="description" content="📦 🎨 一个面向 RESTful API 设计的开箱即用主题。">
+
+
+    <link rel="preload" href="/assets/css/4.styles.a4d6186c.css" as="style"><link rel="preload" href="/assets/js/app.6988c9c6.js" as="script"><link rel="preload" href="/assets/js/0.15a368a1.js" as="script"><link rel="prefetch" href="/assets/js/1.1d8a9ed7.js"><link rel="prefetch" href="/assets/js/2.e138d13a.js"><link rel="prefetch" href="/assets/js/3.7528a031.js">
+    <link rel="stylesheet" href="/assets/css/4.styles.a4d6186c.css">
+  </head>
+  <body>
+    <div id="app" data-server-rendered="true"><div class="theme__container sidebar-open"><div class="row"><div class="col-md-2"><div class="sidebar"><div class="group"><div class="group__title">Other Language</div><div class="group__body"><!----><div name="/" class="group__category category"><div class="category__label"><a href="/" class="router-link-active">English</a></div></div><div name="/zh/" class="group__category category"><div class="category__label"><a href="/zh/" class="router-link-active">中文</a></div></div></div></div><div class="group"><div class="group__title">Home</div><div class="group__body"><div class="group__category category"><div class="category__label"><a href="/zh/" class="router-link-active">Homepage</a></div></div></div></div><div class="group"><div class="group__title">getting-started</div><div class="group__body"><div class="group__category category category--selected category--active"><div class="category__label"><a href="/zh/getting-started/" class="router-link-exact-active router-link-active">起步</a></div></div><div class="group__category category"><div class="category__label"><a href="/zh/getting-started/#aha">Aha</a></div></div></div></div></div></div><div class="col-md-10"><div class="page__container"><div class="content custom"><h1 id="起步"><a href="#起步" aria-hidden="true" class="header-anchor">#</a> 起步</h1><h2 id="aha"><a href="#aha" aria-hidden="true" class="header-anchor">#</a> aha</h2><p>this is a title.</p></div></div></div></div></div></div>
+    <script src="/assets/js/0.15a368a1.js" defer></script><script src="/assets/js/app.6988c9c6.js" defer></script>
+  </body>
+</html>
diff --git a/docs/.vuepress/dist/zh/index.html b/docs/.vuepress/dist/zh/index.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="zh-hans">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Hello, World.</title>
+    <meta name="description" content="不知道从哪里开始？我们准备了一些你可以用来开始构建的便捷指南和参考文档。">
+
+
+    <link rel="preload" href="/assets/css/4.styles.a4d6186c.css" as="style"><link rel="preload" href="/assets/js/app.6988c9c6.js" as="script"><link rel="preload" href="/assets/js/1.1d8a9ed7.js" as="script"><link rel="prefetch" href="/assets/js/0.15a368a1.js"><link rel="prefetch" href="/assets/js/2.e138d13a.js"><link rel="prefetch" href="/assets/js/3.7528a031.js">
+    <link rel="stylesheet" href="/assets/css/4.styles.a4d6186c.css">
+  </head>
+  <body>
+    <div id="app" data-server-rendered="true"><div class="theme__container no-sidebar"><div><div class="home__container container"><div class="home__header"><h1 class="home__title">Hello, World.</h1><p class="home__description">不知道从哪里开始？我们准备了一些你可以用来开始构建的便捷指南和参考文档。</p><a href="/zh//getting-started" class="btn btn--default btn--default">开始出发</a></div><div class="home__body row"><div class="home__content col-md-10"><div class="content custom"><h3 id="as-easy-as-1-2-3"><a href="#as-easy-as-1-2-3" aria-hidden="true" class="header-anchor">#</a> As Easy as 1, 2, 3</h3><pre class="language-bash"><code><span class="token comment"># install vuepress</span>
+yarn global add vuepress <span class="token comment"># OR npm install -g vuepress</span>
+
+<span class="token comment"># install theme</span>
+yarn global add vuepress-theme-api <span class="token comment"># OR npm install -g vuepress-theme-api</span>
+
+<span class="token comment"># create a markdown file and write something</span>
+<span class="token keyword">echo</span> <span class="token string">'# Hello, World.'</span> <span class="token operator">&gt;</span> Hello.md
+
+<span class="token comment"># start writing</span>
+vuepress dev
+
+<span class="token comment"># build to static files</span>
+vuepress build
+</code></pre><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>VuePress requires <a href="http://nodejs.org/" target="_blank" rel="noopener noreferrer">Node.js</a> &gt;= 8.</p></div><section class="section section--dark section--center"><div class="container"><div class="row enhance-mode__homepage"><div class="col-md-10"><h2 id="build-for-restful-api"><a href="#build-for-restful-api" aria-hidden="true" class="header-anchor">#</a> Build for RESTful API</h2><p>A easy-to-use, minimalist theme for vuepress.</p><p>With out-of-the-box feature, all you need to do is install it and write something.</p><br><a href="/getting-started/" class="btn btn--light btn--default">Getting Started</a></div></div></div></section></div></div></div><footer class="home__footer"><p>Open Source on <a href="https://github.com/sqrthree/vuepress-theme-api">GitHub</a>, Made by <a href="https://github.com/sqrthree">@sqrthree</a>, Power by <a href="https://github.com/vuejs/vuepress">vuepress</a>.</p>
+</footer></div></div></div></div>
+    <script src="/assets/js/1.1d8a9ed7.js" defer></script><script src="/assets/js/app.6988c9c6.js" defer></script>
+  </body>
+</html>
diff --git a/docs/.vuepress/public/favicon.ico b/docs/.vuepress/public/favicon.ico