Skip to content

Commit 236c390

Browse files
committed
Added publish command and footer
1 parent d896748 commit 236c390

File tree

4 files changed

+112
-18
lines changed

4 files changed

+112
-18
lines changed

content/commands.html

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,5 +176,37 @@
176176

177177
: Displays the help text for the `serve` command.
178178

179+
## The publish command
179180

180-
[configuration]: [[config]]
181+
Publishes the site based on configuration. Currently the only supported
182+
publishing target is a git repository. See the [publisher documentation][]
183+
for more information.
184+
185+
~~~~sh~~~~~
186+
hyde [-s </site/path>] [-v] publish -p <conf> [-m <msg>] [-c <config/path>] [-h]
187+
~~~~~~~~~~~
188+
189+
`-s SITEPATH, --sitepath SITEPATH`
190+
: The path to the site to be generated.
191+
192+
*Optional* - defaults to current working directory.
193+
194+
`-p CONFIG`
195+
196+
: This should point to a configuration section in the site configuration
197+
that has the settings for the publisher. For example:
198+
199+
The following configuration (taken from this site) when invoked with
200+
`hyde publish -p github` will use the Git publisher to publish the
201+
generated site to `hyde/hyde.github.com` repository.
202+
203+
~~~yaml~~~~
204+
publisher:
205+
github:
206+
type: hyde.ext.publishers.dvcs.Git
207+
path: ../hyde.github.com
208+
url: [email protected]:hyde/hyde.github.amrom.workers.dev.git
209+
~~~~~~~~~~
210+
211+
[configuration]: [[config]]
212+
[publisher]: [[publisher]]

content/install.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222

2323
## Dependencies
2424

25-
While your mileage may vary, I consider the following to be essential for
25+
While your mileage may vary, we consider the following to be essential for
2626
generating a static website with hyde. These are a part of the requirements
27-
file and the above command will download and install most of them as part
27+
file and the above command will download and install all of them as part
2828
of hyde.
2929

3030
It is also recommended that you use [virtualenv][] to separate the hyde

content/media/css/site.less

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ header.banner {
5656
position: relative;
5757
}
5858

59-
aside.toc{
59+
aside{
6060

6161
mark.version{
6262
color: @darkest;
@@ -70,13 +70,24 @@ aside.toc{
7070
display: block;
7171
}
7272

73-
.boxshadow(0, 1px, 3px, @qdark);
74-
padding: 12px;
75-
line-height: 24px;
73+
ul{
74+
padding:0;
75+
}
76+
77+
ul.toc{
78+
.boxshadow(0, 1px, 3px, @qdark);
79+
padding: @gutter;
80+
81+
li{
82+
list-style-type: none;
83+
}
84+
}
85+
86+
line-height: @gutter * 2;
7687
position: fixed;
77-
top: 12px;
78-
right: 12px;
79-
font-size: 12px;
88+
top: @gutter * 2;
89+
right: @gutter * 2;
90+
font-size: @gutter;
8091

8192
a:before{
8293
content: '\00a0\00a0';
@@ -95,14 +106,26 @@ aside.toc{
95106
background-color: #ededed;
96107
}
97108

98-
ul{
99-
padding:0;
100-
}
101-
102-
li{
109+
li {
103110
margin:0;
104111
list-style-type: none;
105112
}
113+
114+
nav.prevnext{
115+
116+
margin: @gutter 0;
117+
.prev{
118+
display: block;
119+
float: left;
120+
}
121+
122+
.next{
123+
display: block;
124+
float: right;
125+
padding-right: @gutter * 0.75;
126+
}
127+
}
128+
106129
}
107130

108131
article {
@@ -127,6 +150,19 @@ article {
127150
}
128151
}
129152

153+
footer{
154+
position: fixed;
155+
color: black;
156+
bottom: 0;
157+
right: @gutter * 2;
158+
font-size: @gutter - 2;
159+
line-height: @gutter;
160+
161+
li {
162+
list-style-type: none;
163+
}
164+
}
165+
130166
.code{
131167
position: relative;
132168

layout/doc.j2

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
{%- endblock %}
1212
{%- endfilter %}
1313
</article>
14-
<aside class="toc">
15-
<mark class="version">Version: {{ version }}</mark>
16-
<ul>
14+
<aside>
15+
<ul class="toc">
16+
<li><mark class="version">Version: {{ version }}</mark></li>
1717
{% for topic, res_walker in site.content.walk_toc_groups() -%}
1818
{% set resources = res_walker|list -%}
1919
{% if resources -%}
@@ -36,6 +36,32 @@
3636
{%- endif %}
3737
{%- endfor %}
3838
</ul>
39+
<nav class="prevnext">
40+
{% if resource.prev_in_toc -%}
41+
<a
42+
class="prev"
43+
title="{{ resource.prev_in_toc.meta.title }}"
44+
href="{{ content_url(resource.prev_in_toc.url) }}">
45+
&larr;Previous
46+
</a>
47+
{%- endif %}
48+
{% if resource.next_in_toc -%}
49+
<a
50+
class="next"
51+
title="{{ resource.next_in_toc.meta.title }}"
52+
href="{{ content_url(resource.next_in_toc.url) }}">
53+
Next&rarr;
54+
</a>
55+
{%- endif %}
56+
<br class="clear">
57+
</nav>
3958
</aside>
4059
</div>
60+
<footer>
61+
{% filter markdown|typogrify %}
62+
[smelted with hyde](https://github.com/hyde/hyde) &mdash;
63+
[spot & complain](https://github.com/hyde/hyde.github.com/issues) &mdash;
64+
[fork & fix](https://github.com/hyde/hyde.github.com)
65+
{% endfilter %}
66+
</footer>
4167
{%- endblock %}

0 commit comments

Comments
 (0)