-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathget-started.html
91 lines (69 loc) · 11.2 KB
/
get-started.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Metaverse Documantation | Get Started </title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- fonts -->
<link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700" rel="stylesheet">
<link href="//fonts.googleapis.com/css?family=Ubuntu:300,400,500,600,700" rel="stylesheet">
<!-- stylesheets -->
<link rel="stylesheet" href="/style/doc.css">
<!-- favicon -->
<link rel="icon" href="/favicon.ico">
</head>
<body>
<script>window.__INITIAL_STATE__ = {"page":{"title":"Get Started","path":"get-started.html"},"data":{"navigation":{"logo":{"text":"Metaverse Documentaion","type":"link","path":"index.html"},"main":[{"text":"概览","type":"link","path":"index.html"},{"text":"开始学习","type":"link","path":"get-started.html"},{"text":"全节点钱包","type":"link","path":"full-node-wallet/index.html","children":[{"text":"链上存款(锁仓)","type":"link","path":"full-node-wallet/onchain-deposit.html"},{"text":"发行代币","type":"link","path":"full-node-wallet/issue-token.html"},{"text":"转移代币","type":"link","path":"full-node-wallet/transfer-token.html"},{"text":"主网参数","type":"link","path":"full-node-wallet/mainnet-parameters.html"},{"text":"在命令行环境使用","type":"link","path":"full-node-wallet/command-line.html"}]},{"text":"白皮书概要","type":"label","children":[{"text":"元界白皮书","type":"link","path":"whitepaper/metaverse.html"},{"text":"元界数字身份白皮书","type":"link","path":"whitepaper/digital-identity.html"}]},{"text":"开发使用与配置","type":"label"},{"text":"介绍","type":"link","path":"usage-and-configuration/introduction.html"},{"text":"编译","type":"link","path":"usage-and-configuration/build/index.html","children":[{"text":"Linux","type":"link","path":"usage-and-configuration/build/linux.html"},{"text":"Windows","type":"link","path":"usage-and-configuration/build/windows.html"},{"text":"MacOSX","type":"link","path":"usage-and-configuration/build/macosx.html"}]},{"text":"配置选项","type":"link","path":"usage-and-configuration/startup-options.html"},{"text":"测试网络","type":"link","path":"usage-and-configuration/testnet.html"},{"text":"命令行参考","type":"link","path":"usage-and-configuration/command-line-reference.html"},{"text":"搭建私有链","type":"link","path":"usage-and-configuration/private-chain.html"},{"text":"开发者文档","type":"label"},{"text":"数字资产账本","type":"link","path":"developers/digital-asset/index.html","children":[{"text":"链上存款(锁仓)","type":"link","path":"developers/digital-asset/onchain-deposit.html"},{"text":"自定义资产","type":"link","path":"developers/digital-asset/issue-token.html"}]},{"text":"数字身份账本","type":"link","path":"developers/digital-identity/index.html"},{"text":"底层技术","type":"link","path":"developers/base-layer/index.html","children":[{"text":"P2P网络","type":"link","path":"developers/base-layer/p2p-network.html"},{"text":"高性能数据库","type":"link","path":"developers/base-layer/database.html"},{"text":"内嵌式HTTPServer","type":"link","path":"developers/base-layer/httpserver.html"},{"text":"共识机制与挖矿","type":"link","path":"developers/base-layer/consensus-and-mining.html"},{"text":"HD账户与加密模块","type":"link","path":"developers/base-layer/account-model.html"},{"text":"UTXO扩展与Script扩展","type":"link","path":"developers/base-layer/utxo-and-script.html"}]}]}},"config":{"timezone":null,"root":"/","time_format":"HH:mm:ss","theme":"doc","theme_config":{"swagger_ui":{"api_explorer":true,"permalinks":true},"search":{"skip":false,"background":false,"route":"/lunr.json"},"favicon":"/favicon.ico"}}}</script>
<div id="react-navigation-root"><div class="doc-navigation" data-reactroot=""><nav class="doc-navbar"><a href="/index.html" class="doc-navbar__logo"><img src="/images/logo.png" class="doc-navbar__logo__img"/><span class="doc-navbar__logo__text">Metaverse Documentaion</span></a><i class="dc-icon dc-icon--close dc-icon--interactive doc-sidebar-close doc-navbar__sidebar-close doc-navbar__sidebar-close--desktop"></i><i class="dc-icon dc-icon--menu dc-icon--interactive doc-sidebar-toggle doc-navbar__sidebar-toggle"></i></nav><nav class="doc-sidebar"><div class="doc-sidebar__vertical-menu"><i class="dc-icon dc-icon--menu dc-icon--interactive doc-sidebar-toggle doc-sidebar-toggle--primary doc-sidebar__vertical-menu__item"></i><i class="dc-icon dc-icon--search dc-icon--interactive doc-sidebar__vertical-menu__item doc-sidebar__vertical-menu__item--primary"></i></div><div class="doc-sidebar-content"><div class="doc-sidebar__search-form"></div><ul class="doc-sidebar-list"></ul></div></nav></div></div>
<div class="doc-content">
<div class="dc-page">
<div class="dc-card">
<div id="react-search-results-root"></div>
<div id="page-content" class="doc-formatting">
<h1 id="Get-started"><a href="#Get-started" class="headerlink" title="Get started"></a>Get started</h1><h2 id="Requirements"><a href="#Requirements" class="headerlink" title="Requirements"></a>Requirements</h2><p>To get started you need to have a couple of things installed:</p>
<ul>
<li><a href="https://nodejs.org" target="_blank" rel="noopener">NodeJS</a></li>
<li><a href="https://git-scm.com" target="_blank" rel="noopener">Git</a></li>
</ul>
<h3 id="Installing-Hexo"><a href="#Installing-Hexo" class="headerlink" title="Installing Hexo"></a>Installing Hexo</h3><p>Once all the requirements are installed, you can install <a href="https://hexo.io/" target="_blank" rel="noopener">Hexo</a> with npm:</p>
<figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">$ npm install -g hexo-cli</span><br></pre></td></tr></table></figure>
<h2 id="Quick-Start"><a href="#Quick-Start" class="headerlink" title="Quick Start"></a>Quick Start</h2><p>To quickly bootstrap a documentation website, we have setup an <a href="https://github.com/zalando-incubator/hexo-theme-doc-seed" target="_blank" rel="noopener">example seed project</a> that can be <strong>cloned</strong> and used a starting point.</p>
<ul>
<li>Clone the seed project</li>
</ul>
<figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">$ git clone https://github.com/zalando-incubator/hexo-theme-doc-seed.git</span><br></pre></td></tr></table></figure>
<ul>
<li>Go into the resulting directory and install the dependencies</li>
</ul>
<figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">$ cd hexo-theme-doc-seed && npm install</span><br></pre></td></tr></table></figure>
<ul>
<li>Start the preview server</li>
</ul>
<figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">$ hexo s</span><br></pre></td></tr></table></figure>
<p>This command will run a built-in http server and watch for changes.</p>
<p>If you open your browser to <a href="http://localhost:4000" target="_blank" rel="noopener">http://localhost:4000</a> you should see the documentation website up and running.<br>Nice! Now you can start <a href="./usage-and-configuration/writing.html">writing</a> your content… have fun!</p>
<blockquote>
<p>To know more, please check <a href="https://hexo.io/docs/server.html" target="_blank" rel="noopener">server</a> and <a href="https://hexo.io/docs/generating.html" target="_blank" rel="noopener">generating</a> from the official Hexo documentation.</p>
</blockquote>
<h2 id="Long-Start"><a href="#Long-Start" class="headerlink" title="Long Start"></a>Long Start</h2><p>This section assumes that you are familiar with <a href="https://hexo.io" target="_blank" rel="noopener">Hexo</a> usage. For new starters we suggest you have a look at the <a href="#Quick-Start">Quick Start</a> guide.</p>
<h3 id="Install-via-npm-recommended"><a href="#Install-via-npm-recommended" class="headerlink" title="Install via npm (recommended)"></a>Install via npm (recommended)</h3><figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">$ npm install git+ssh://[email protected]:zalando-incubator/hexo-theme-doc.git --save</span><br></pre></td></tr></table></figure>
<p>Symlink the package in the <code>themes</code> folder. For Linux:</p>
<figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">$ ln -s ./themes/doc ./node_modules/hexo-theme-doc</span><br></pre></td></tr></table></figure>
<p>Install the required hexo plugins in your project:<br><figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">$ npm install hexo-renderer-ejs hexo-renderer-marked --save</span><br></pre></td></tr></table></figure></p>
<h3 id="Install-via-git-not-recommended"><a href="#Install-via-git-not-recommended" class="headerlink" title="Install via git (not recommended)"></a>Install via git (not recommended)</h3><figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br></pre></td><td class="code"><pre><span class="line">$ git clone [email protected]:zalando-incubator/hexo-theme-doc.git themes/doc</span><br><span class="line">$ cd themes/doc && npm install --prod</span><br></pre></td></tr></table></figure>
<p>Install the required hexo plugins in your project:<br><figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">$ npm install hexo-renderer-ejs hexo-renderer-marked --save</span><br></pre></td></tr></table></figure></p>
<h3 id="Activate-the-theme"><a href="#Activate-the-theme" class="headerlink" title="Activate the theme"></a>Activate the theme</h3><p>Update your project <code>_config.yml</code></p>
<figure class="highlight yaml"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br></pre></td><td class="code"><pre><span class="line"><span class="attr">theme:</span> <span class="string">doc</span></span><br><span class="line"></span><br><span class="line"><span class="attr">ignore:</span></span><br><span class="line"><span class="bullet"> -</span> <span class="string">'**/themes/**/*(node_modules|lib)'</span> <span class="comment"># improve performance while `hexo server` is running</span></span><br></pre></td></tr></table></figure>
<div id="react-support-footer-root"></div>
</div>
</div>
</div>
</div>
<!-- js vendors -->
<script src="//code.jquery.com/jquery-3.2.1.min.js" crossorigin="anonymous"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/lunr.js/2.1.0/lunr.min.js"></script>
<!-- js source -->
<script src="/script/doc.js"></script>
</body>
</html>