docs: Add assets/instructions for local docs build (#2453)

* ungitignore * add docs/.vuepress to enable local builds * config.js needs to be here, one less step * docs: make spec in sidebar nicer * docs: local build instructions
6 years ago · 886a83dfb8
--- a/.gitignore
+++ b/.gitignore
@ -14,7 +14,6 @@ test/p2p/data/
 test/logs
 coverage.txt
 docs/_build
 docs/.vuepress
 docs/dist
 *.log
 abci-cli
@ -42,4 +41,4 @@ terraform.tfstate
 terraform.tfstate.backup
 terraform.tfstate.d
 .vscode
 .vscode
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
--- a/docs/.vuepress/dist/404.html
+++ b/docs/.vuepress/dist/404.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>VuePress</title>
    <meta name="description" content="">
    <link rel="preload" href="/assets/css/1.styles.c01b7ee3.css" as="style"><link rel="preload" href="/assets/js/app.48f1ff5f.js" as="script"><link rel="prefetch" href="/assets/js/0.7c2695bf.js">
    <link rel="stylesheet" href="/assets/css/1.styles.c01b7ee3.css">
  </head>
  <body>
    <div id="app" data-server-rendered="true"><div class="theme-container"><div class="content"><h1>404</h1><blockquote>Looks like we've got some broken links.</blockquote><a href="/" class="router-link-active">Take me home.</a></div></div></div>
    <script src="/assets/js/app.48f1ff5f.js" defer></script>
  </body>
 </html>
--- a/docs/.vuepress/dist/assets/css/1.styles.c01b7ee3.css
+++ b/docs/.vuepress/dist/assets/css/1.styles.c01b7ee3.css
--- a/docs/.vuepress/dist/assets/img/search.83621669.svg
+++ b/docs/.vuepress/dist/assets/img/search.83621669.svg
@ -0,0 +1 @@
 <?xml version="1.0" encoding="UTF-8"?><svg xmlns="http://www.w3.org/2000/svg" width="12" height="13"><g stroke-width="2" stroke="#aaa" fill="none"><path d="M11.29 11.71l-4-4"/><circle cx="5" cy="5" r="4"/></g></svg>
--- a/docs/.vuepress/dist/assets/js/0.7c2695bf.js
+++ b/docs/.vuepress/dist/assets/js/0.7c2695bf.js
@ -0,0 +1 @@
 (window.webpackJsonp=window.webpackJsonp||[]).push([[0],{136:function(e,t,s){"use strict";s.r(t);var n=s(0),r=Object(n.a)({},function(){this.$createElement;this._self._c;return this._m(0)},[function(){var e=this.$createElement,t=this._self._c||e;return t("div",{staticClass:"content"},[t("h1",{attrs:{id:"hello-vuepress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hello-vuepress","aria-hidden":"true"}},[this._v("#")]),this._v(" Hello VuePress")])])}],!1,null,null,null);t.default=r.exports}}]);
--- a/docs/.vuepress/dist/assets/js/app.48f1ff5f.js
+++ b/docs/.vuepress/dist/assets/js/app.48f1ff5f.js
--- a/docs/.vuepress/dist/index.html
+++ b/docs/.vuepress/dist/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 VuePress</title>
    <meta name="description" content="">
    <link rel="preload" href="/assets/css/1.styles.c01b7ee3.css" as="style"><link rel="preload" href="/assets/js/app.48f1ff5f.js" as="script"><link rel="preload" href="/assets/js/0.7c2695bf.js" as="script">
    <link rel="stylesheet" href="/assets/css/1.styles.c01b7ee3.css">
  </head>
  <body>
    <div id="app" data-server-rendered="true"><div class="theme-container no-sidebar"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div><a href="/" class="home-link router-link-exact-active router-link-active"></a><div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""><!----></div><!----></div></header><div class="sidebar-mask"></div><div class="sidebar"><!----><!----></div><div class="page"><div class="content"><h1 id="hello-vuepress"><a href="#hello-vuepress" aria-hidden="true" class="header-anchor">#</a> Hello VuePress</h1></div><div class="page-edit"><!----><!----></div><!----></div></div></div>
    <script src="/assets/js/0.7c2695bf.js" defer></script><script src="/assets/js/app.48f1ff5f.js" defer></script>
  </body>
 </html>
--- a/docs/DOCS_README.md
+++ b/docs/DOCS_README.md
@ -24,7 +24,7 @@ on the website.
 ## Config.js
 The [config.js](./config.js) generates the sidebar and Table of Contents
 The [config.js](./.vuepress/config.js) generates the sidebar and Table of Contents
 on the website docs. Note the use of relative links and the omission of
 file extensions. Additional features are available to improve the look
 of the sidebar.
@ -59,9 +59,36 @@ to send users to the GitHub.
 ## Building Locally
 Not currently possible but coming soon! Doing so requires
 assets held in the (private) website repo, installing
 [VuePress](https://vuepress.vuejs.org/), and modifying the `config.js`.
 To build and serve the documentation locally, run:
 ```
 # from this directory
 npm install
 npm install -g vuepress
 ```
 then change the following line in the `config.js`:
 ```
 base: "/docs/",
 ```
 to:
 ```
 base: "/",
 ```
 Finally, go up one directory to the root of the repo and run:
 ```
 # from root of repo
 vuepress build docs
 cd dist/docs
 python -m SimpleHTTPServer 8080
 ```
 then navigate to localhost:8080 in your browser.
 ## Consistency
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
--- a/docs/spec/README.md
+++ b/docs/spec/README.md
@ -1,4 +1,4 @@
 # Tendermint Specification
 # Overview
 This is a markdown specification of the Tendermint blockchain.
 It defines the base data structures, how they are validated,
--- a/docs/spec/blockchain/blockchain.md
+++ b/docs/spec/blockchain/blockchain.md
@ -1,4 +1,4 @@
 # Tendermint Blockchain
 # Blockchain
 Here we describe the data structures in the Tendermint blockchain and the rules for validating them.
--- a/docs/spec/blockchain/encoding.md
+++ b/docs/spec/blockchain/encoding.md
@ -1,4 +1,4 @@
 # Tendermint Encoding
 # Encoding
 ## Amino
--- a/docs/spec/blockchain/state.md
+++ b/docs/spec/blockchain/state.md
@ -1,4 +1,4 @@
 # Tendermint State
 # State
 ## State
--- a/docs/spec/consensus/bft-time.md
+++ b/docs/spec/consensus/bft-time.md
@ -1,4 +1,4 @@
 # BFT time in Tendermint 
 # BFT Time
 Tendermint provides a deterministic, Byzantine fault-tolerant, source of time. 
 Time in Tendermint is defined with the Time field of the block header. 
--- a/docs/spec/consensus/light-client.md
+++ b/docs/spec/consensus/light-client.md
@ -1,4 +1,4 @@
 # Light client
 # Light Client
 A light client is a process that connects to the Tendermint Full Node(s) and then tries to verify the Merkle proofs
 about the blockchain application. In this document we describe mechanisms that ensures that the Tendermint light client
--- a/docs/spec/p2p/node.md
+++ b/docs/spec/p2p/node.md
@ -1,4 +1,4 @@
 # Tendermint Peer Discovery
 # Peer Discovery
 A Tendermint P2P network has different kinds of nodes with different requirements for connectivity to one another.
 This document describes what kind of nodes Tendermint should enable and how they should work.
--- a/docs/spec/p2p/peer.md
+++ b/docs/spec/p2p/peer.md
@ -1,4 +1,4 @@
 # Tendermint Peers
 # Peers
 This document explains how Tendermint Peers are identified and how they connect to one another.