From c5a2f41969454e0eca16895d951e242b41c295e4 Mon Sep 17 00:00:00 2001 From: Adam Schmideg Date: Fri, 18 Jan 2019 12:11:35 +0100 Subject: [PATCH] Template for docs pages with sidebar --- _config.yml | 9 ++++++++- _data/sidebar.yml | 32 ++++++++++++++++++++++++++++++++ _layouts/default.html | 5 +++-- _layouts/sidebar.html | 22 ++++++++++++++++++++++ docs/index.md | 1 + 5 files changed, 66 insertions(+), 3 deletions(-) create mode 100644 _data/sidebar.yml create mode 100644 _layouts/sidebar.html create mode 100644 docs/index.md diff --git a/_config.yml b/_config.yml index a6e723a5ae..e90c681f0f 100644 --- a/_config.yml +++ b/_config.yml @@ -3,4 +3,11 @@ repository: ethereum/go-ethereum exclude: - Gemfile - Gemfile.lock - - .gitignore \ No newline at end of file + - .gitignore + +defaults: + - + scope: + path: docs + values: + layout: sidebar \ No newline at end of file diff --git a/_data/sidebar.yml b/_data/sidebar.yml new file mode 100644 index 0000000000..04840fab6a --- /dev/null +++ b/_data/sidebar.yml @@ -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 \ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html index b2ece5740e..e7d41a872f 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -16,8 +16,9 @@ diff --git a/_layouts/sidebar.html b/_layouts/sidebar.html new file mode 100644 index 0000000000..17d206a954 --- /dev/null +++ b/_layouts/sidebar.html @@ -0,0 +1,22 @@ +--- +layout: default +--- +
+
+
+ {% for group in site.data.sidebar %} +
+ {{ group[0] }} + {% for link in group[1] %} + {{ link.first[0] }} + {% endfor %} +
+ {% endfor %} +
+
+ {{ content }} +
+
+ +
\ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..7bdd7cf93c --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Welcome to the documentation \ No newline at end of file