mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-08-20 02:42:27 +00:00
Template for docs pages with sidebar
This commit is contained in:
parent
c4fb87402f
commit
c5a2f41969
5 changed files with 66 additions and 3 deletions
|
|
@ -4,3 +4,10 @@ exclude:
|
||||||
- Gemfile
|
- Gemfile
|
||||||
- Gemfile.lock
|
- Gemfile.lock
|
||||||
- .gitignore
|
- .gitignore
|
||||||
|
|
||||||
|
defaults:
|
||||||
|
-
|
||||||
|
scope:
|
||||||
|
path: docs
|
||||||
|
values:
|
||||||
|
layout: sidebar
|
||||||
32
_data/sidebar.yml
Normal file
32
_data/sidebar.yml
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
Install and build:
|
||||||
|
- Downloads: /downloads
|
||||||
|
- Installing Ethereum: /docs/Building-Ethereum
|
||||||
|
- Developers' Guide: /docs/Developers%27-Guide
|
||||||
|
How to use:
|
||||||
|
- Managing Accounts: /docs/Managing-your-accounts
|
||||||
|
- Mining: /docs/Mining
|
||||||
|
- Contract Tutorial: /docs/Contract-Tutorial
|
||||||
|
Interface Documentation:
|
||||||
|
- Command Line Options: /docs/Command-Line-Options
|
||||||
|
- JavaScript Console: /docs/JavaScript-Console
|
||||||
|
- Management API: /docs/Management-APIs
|
||||||
|
- JSON-RPC server: https://github.com/ethereum/wiki/wiki/JSON-RPC
|
||||||
|
Issues and support:
|
||||||
|
- FAQ: /docs/FAQ
|
||||||
|
- Reporting issues: /docs/geth#reporting
|
||||||
|
- Community and support: /docs/geth#community-and-support
|
||||||
|
- Issue handling workflow: /docs/Issue-handling-workflow
|
||||||
|
Developers:
|
||||||
|
- Mobile Clients: /docs/Mobile-Clients/Libraries-and-Inproc-Ethereum-Nodes
|
||||||
|
- Native DApps: /docs/Native-DApps/Go-bindings-to-Ethereum-contracts
|
||||||
|
- Active go-ethereum projects: /docs/Active-go-ethereum-projects
|
||||||
|
- Other documents: /docs/other-documents
|
||||||
|
Swarm and friends:
|
||||||
|
- TODO: /docs/Swarm---TODO
|
||||||
|
- distributed preimage archive: /docs/Swarm---distributed-preimage-archive
|
||||||
|
- Channels, Namereg-resolution: /docs/Swarm-Channels,-Namereg-resolution-draft
|
||||||
|
- Contract: /docs/Swarm-Contract
|
||||||
|
- POC series: /docs/swarm---POC-series
|
||||||
|
- dev progress: /docs/swarm-dev-progress
|
||||||
|
- roadmap: /docs/swarm-roadmap
|
||||||
|
- IPFS & SWARM: /docs/IPFS-&-SWARM
|
||||||
|
|
@ -16,8 +16,9 @@
|
||||||
</div>
|
</div>
|
||||||
<div id="navbar" class="navbar-collapse collapse">
|
<div id="navbar" class="navbar-collapse collapse">
|
||||||
<ul class="nav navbar-nav">
|
<ul class="nav navbar-nav">
|
||||||
<li><a href="install/">Install</a></li>
|
<li><a href="/install/">Install</a></li>
|
||||||
<li><a href="downloads/">Downloads</a></li>
|
<li><a href="/downloads/">Downloads</a></li>
|
||||||
|
<li><a href="/docs/">Documentation</a></li>
|
||||||
<!--<li><a href="/guide/">Guide</a></li>-->
|
<!--<li><a href="/guide/">Guide</a></li>-->
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
||||||
22
_layouts/sidebar.html
Normal file
22
_layouts/sidebar.html
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
---
|
||||||
|
layout: default
|
||||||
|
---
|
||||||
|
<div class="container" style="padding-top: 24px;">
|
||||||
|
<div class="row">
|
||||||
|
<div class="col-md-3" id="toc" style="padding-top: 16px;">
|
||||||
|
{% for group in site.data.sidebar %}
|
||||||
|
<div class="list-group">
|
||||||
|
<a class="list-group-item active">{{ group[0] }}</a>
|
||||||
|
{% for link in group[1] %}
|
||||||
|
<a class="list-group-item"
|
||||||
|
href="{{ link.first[1] }}">{{ link.first[0] }}</a>
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
<div class="col-md-9" id="content">
|
||||||
|
{{ content }}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
1
docs/index.md
Normal file
1
docs/index.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Welcome to the documentation
|
||||||
Loading…
Reference in a new issue