Skip to content
This repository was archived by the owner on Sep 16, 2019. It is now read-only.

Commit 467062b

Browse files
NicolasMassartNicolasMassart
committed
add templates and add exclude plugin and doc repos url for template
Also remove unused pages
1 parent 8b42413 commit 467062b

File tree

12 files changed

+151
-119
lines changed

12 files changed

+151
-119
lines changed

‎docs/Configuring-Pantheon/Networking/Configuring-Ports.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The default is `30303`.
2626

2727
## JSON-RPC API
2828

29-
To enable access to the [JSON-RPC API](../../Pantheon-API/JSON-RPC-API.md), open the HTTP JSON-RPC and WebSockets JSON-RPC ports to the intended users
29+
To enable access to the [JSON-RPC API](../../Pantheon-API/Pantheon-API.md), open the HTTP JSON-RPC and WebSockets JSON-RPC ports to the intended users
3030
of the JSON-RPC API on TCP.
3131

3232
The [`--rpc-http-port`](../../Reference/Pantheon-CLI-Syntax.md#rpc-http-port) and [`--rpc-ws-port`](../../Reference/Pantheon-CLI-Syntax.md#rpc-ws-port)

‎docs/Consensus-Protocols/Consensus-Mechanisms.md‎

Lines changed: 0 additions & 76 deletions
This file was deleted.

‎docs/GettingStartedBinaries.md‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎docs/Pantheon-API/JSON-RPC-API.md‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/custom_theme/404.html‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,23 @@
33
<!-- Content block -->
44
{% block content %}
55

6-
<p style="text-align: center;font-size: 3em"><i class="md-icon">account_balance</i></p>
6+
<p style="text-align: center;font-size: 3em">
7+
{% if config.theme.logo.icon %}
8+
<i class="md-icon">{{ config.theme.logo.icon }}</i>
9+
{% else %}
10+
<img src="{{ config.theme.logo | url }}" height="3em" />
11+
{% endif %}
12+
</p>
13+
714
<h1 id="404-page-not-found" style="text-align: center">404</h1>
8-
<p style="text-align: center"><strong>Deity not found in the Pantheon</strong></p>
15+
<p style="text-align: center"><strong>Sorry but we can't find the page you asked for.</strong></p>
916
<p style="text-align: center">
1017
Try the <a href="/">homepage</a>, or use the search field on the top of this page.
1118
</p>
1219
<p style="text-align: center">
1320
If you think we made a mistake and deleted a page that should be here, then please tell us on
1421
<a href="{{config.extra.support.gitter}}">{{config.site_name}} Gitter channel</a> or create an issue in
15-
<a href="{{ config.repo_url + '/issues' }}">Pantheon Github repository</a>.
22+
<a href="{{config.extra.support.issues}}">{{config.site_name}} Jira</a>.
1623
</p>
1724

1825
{% endblock %}

docs/custom_theme/assets/javascripts/pantheon_custom.js renamed to docs/custom_theme/assets/javascripts/custom_theme.js

File renamed without changes.

docs/custom_theme/assets/stylesheets/pantheon_custom.css renamed to docs/custom_theme/assets/stylesheets/custom_theme.css

File renamed without changes.

‎docs/custom_theme/main.html‎

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{% extends "base.html" %}
22

33
{% block extrahead %}
4-
<link rel="stylesheet" href="{{ 'assets/stylesheets/pantheon_custom.css' | url }}">
4+
<link rel="stylesheet" href="{{ 'assets/stylesheets/custom_theme.css' | url }}">
55
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.1/css/all.css" integrity="sha384-gfdkjb5BdAXd+lj+gudLWI+BXq4IuLW5IT+brZEZsLFm++aCMlF1V92rMkPaX4PP" crossorigin="anonymous">
66
<script
77
src="https://code.jquery.com/jquery-1.12.4.min.js"
88
integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ="
99
crossorigin="anonymous"></script>
1010
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML"></script>
11-
<script src="{{ 'assets/javascripts/pantheon_custom.js' | url }}"></script>
11+
<script src="{{ 'assets/javascripts/custom_theme.js' | url }}"></script>
1212
{% if config.extra.google.site_verification %}
1313
<!-- Google site verification for search console -->
1414
<meta name="google-site-verification" content="{{config.extra.google.site_verification}}" />
@@ -33,4 +33,46 @@
3333
{# hero is not used, so use it for warning banner #}
3434
<script>const latestWarningTrigger = "{{config.extra.latest_version_warning.url_contains}}";</script>
3535
<div class="latest-warning">{{config.extra.latest_version_warning.text}}</div>
36+
{% endblock %}
37+
38+
<!-- Content -->
39+
{% block content %}
40+
41+
<!-- Edit button, if URL was defined -->
42+
<!--The button has to point to the doc site and as it's not designed to have doc outside of code
43+
repos we have to replace the mkdocs generated link based on the code repos with the doc repos-->
44+
{% if page.edit_url %}
45+
<a href="{{ page.edit_url | replace(config.repo_url, config.extra.doc_site_edit_url) }}"
46+
title="{{ lang.t('edit.link.title') }}"
47+
class="md-icon md-content__icon">&#xE3C9;<!-- edit --></a>
48+
{% endif %}
49+
50+
<!--
51+
Hack: check whether the content contains a h1 headline. If it
52+
doesn't, the page title (or respectively site name) is used
53+
as the main headline.
54+
-->
55+
{% if not "\x3ch1" in page.content %}
56+
<h1>{{ page.title | default(config.site_name, true)}}</h1>
57+
{% endif %}
58+
59+
<!-- Content -->
60+
{{ page.content }}
61+
62+
<!-- Source files -->
63+
{% block source %}
64+
{% if page and page.meta and page.meta.source %}
65+
<h2 id="__source">{{ lang.t("meta.source") }}</h2>
66+
{% set repo = config.repo_url %}
67+
{% if repo | last == "/" %}
68+
{% set repo = repo[:-1] %}
69+
{% endif %}
70+
{% set path = page.meta.path | default([""]) %}
71+
{% set file = page.meta.source %}
72+
<a href="{{ [repo, path, file] | join('/') }}"
73+
title="{{ file }}" class="md-source-file">
74+
{{ file }}
75+
</a>
76+
{% endif %}
77+
{% endblock %}
3678
{% endblock %}

‎docs/custom_theme/partials/header.html‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
<!--
2+
Copyright (c) 2016-2019 Martin Donath <martin.donath@squidfunk.com>
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to
6+
deal in the Software without restriction, including without limitation the
7+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8+
sell copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in
12+
all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20+
IN THE SOFTWARE.
21+
-->
22+
23+
<!-- Application header -->
24+
<header class="md-header" data-md-component="header">
25+
26+
<!-- Top-level navigation -->
27+
<nav class="md-header-nav md-grid">
28+
<div class="md-flex">
29+
30+
<!-- Link to home -->
31+
<div class="md-flex__cell md-flex__cell--shrink">
32+
<a href="{{ config.site_url | default(nav.homepage.url, true) | url }}"
33+
title="{{ config.site_name }}"
34+
class="md-header-nav__button md-logo">
35+
{% if config.theme.logo.icon %}
36+
<i class="md-icon">{{ config.theme.logo.icon }}</i>
37+
{% else %}
38+
<img src="{{ config.theme.logo | url }}" height="24" />
39+
{% endif %}
40+
</a>
41+
</div>
42+
43+
<!-- Button to toggle drawer -->
44+
<div class="md-flex__cell md-flex__cell--shrink">
45+
<label class="md-icon md-icon--menu md-header-nav__button"
46+
for="__drawer"></label>
47+
</div>
48+
49+
<!-- Header title -->
50+
<div class="md-flex__cell md-flex__cell--stretch">
51+
<div class="md-flex__ellipsis md-header-nav__title"
52+
data-md-component="title">
53+
{% if config.site_name == page.title %}
54+
{{ config.site_name }}
55+
{% else %}
56+
<span class="md-header-nav__topic">
57+
{{ config.site_name }}
58+
</span>
59+
<span class="md-header-nav__topic">
60+
{{ page.title }}
61+
</span>
62+
{% endif %}
63+
</div>
64+
</div>
65+
66+
<!-- Button to open search dialogue -->
67+
<div class="md-flex__cell md-flex__cell--shrink">
68+
{% if "search" in config["plugins"] %}
69+
<label class="md-icon md-icon--search md-header-nav__button"
70+
for="__search"></label>
71+
72+
<!-- Search interface -->
73+
{% include "partials/search.html" %}
74+
{% endif %}
75+
</div>
76+
77+
<!-- Repository containing source -->
78+
{% if config.repo_url %}
79+
<div class="md-flex__cell md-flex__cell--shrink">
80+
<div class="md-header-nav__source">
81+
{% include "partials/source.html" %}
82+
</div>
83+
</div>
84+
{% endif %}
85+
</div>
86+
</nav>
87+
</header>

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Pantheon supports enterprise features including privacy and permissioning.
1818

1919
## What can you do with Pantheon?
2020

21-
Pantheon includes a [command line interface](Reference/Pantheon-CLI-Syntax.md) and [JSON-RPC API](Pantheon-API/JSON-RPC-API.md)
21+
Pantheon includes a [command line interface](Reference/Pantheon-CLI-Syntax.md) and [JSON-RPC API](Pantheon-API/Pantheon-API.md)
2222
for running, maintaining, debugging, and monitoring nodes in an Ethereum network. You can use the API via RPC
2323
over HTTP or via WebSockets, and Pub/Sub is supported. The API supports typical Ethereum functionalities such as:
2424

0 commit comments

Comments
 (0)