Skip to content

Commit 658fd0d

Browse files
ShMcKShMcK
committed
docs improved, fix code formatting
1 parent 1d2f238 commit 658fd0d

File tree

13 files changed

+191
-133
lines changed

13 files changed

+191
-133
lines changed

‎_config.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ video: DbLpdgrYVOU
1818

1919
# Build settings
2020
markdown: kramdown
21-
highlighter: rouge
2221
kramdown:
2322
input: GFM
23+
syntax_highlighter: rouge
2424
permalink: pretty
2525

2626
gems:

‎_includes/build/build.html‎

Lines changed: 50 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -132,64 +132,66 @@ <h2 class="section-heading">Build in Markdown</h2>
132132
}
133133
```
134134
))
135-
</pre>
135+
136136
</code>
137+
</pre>
138+
</div>
137139
</div>
140+
138141
</div>
142+
<!-- /.container -->
139143

140144
</div>
141-
<!-- /.container -->
145+
<!-- /.content-section-b -->
142146

143-
</div>
144-
<!-- /.content-section-b -->
145-
146-
<div class="content-section-a">
147+
<div class="content-section-a">
147148

148-
<div class="container">
149+
<div class="container">
149150

150-
<div class="row">
151-
<div class="col-lg-4 col-sm-6">
152-
<!-- <hr class="section-heading-spacer"> -->
153-
<div class="clearfix"></div>
154-
<h2 class="section-heading">Unit Test Feedback</h2>
155-
<div class="lead">
156-
Write task feedback using unit tests.
157-
<br><br>
158-
<a href="/docs/#test-snippets">Snippets</a>
159-
&
160-
<a href="/docs/#test-examples">examples</a>
161-
make test writing easy.
162-
<br><br>
163-
Currently supported:
164-
<br>
165-
<ul>
166-
<li>Javascript:
167-
<a href="https://github.com/coderoad/mocha-coderoad" target="_blank">Mocha</a>
168-
</li>
169-
</ul>
170-
<br>
171-
<i>CodeRoad will eventually support more test frameworks and programming languages through easy to setup
172-
<a href="/docs/#test-runners">test runners</a>
173-
</i>
174-
<br>
175-
<br>
176-
<ul class="banner-social-buttons">
177-
<li>
178-
<a href="/docs/#tests" class="btn btn-default btn-lg">
179-
<span class="network-name">Test Docs</span>
180-
</a>
181-
</li>
182-
<li>
183-
<a href="https://github.com/coderoad/coderoad-functional-school/blob/master/tutorial/1/01/01-filter.spec.js" target="_blank" class="btn btn-default btn-lg">
184-
<span class="network-name">Example</span>
185-
</a>
186-
</li>
187-
</ul>
151+
<div class="row">
152+
<div class="col-lg-4 col-sm-6">
153+
<!-- <hr class="section-heading-spacer"> -->
154+
<div class="clearfix"></div>
155+
<h2 class="section-heading">Unit Test Feedback</h2>
156+
<div class="lead">
157+
Write task feedback using unit tests.
158+
<br><br>
159+
<a href="/docs/#test-snippets">Snippets</a>
160+
&
161+
<a href="/docs/#test-examples">examples</a>
162+
make test writing easy.
163+
<br><br>
164+
Currently supported:
165+
<br>
166+
<ul>
167+
<li>Javascript:
168+
<a href="https://github.com/coderoad/mocha-coderoad" target="_blank">Mocha</a>
169+
</li>
170+
</ul>
171+
<br>
172+
<i>CodeRoad will eventually support more test frameworks and programming languages with
173+
<a href="/docs/#test-runners">test runner</a>
174+
pacakges.
175+
</i>
176+
<br>
177+
<br>
178+
<ul class="banner-social-buttons">
179+
<li>
180+
<a href="/docs/#tests" class="btn btn-default btn-lg">
181+
<span class="network-name">Test Docs</span>
182+
</a>
183+
</li>
184+
<li>
185+
<a href="https://github.com/coderoad/coderoad-functional-school/blob/master/tutorial/1/01/01-filter.spec.js" target="_blank" class="btn btn-default btn-lg">
186+
<span class="network-name">Example</span>
187+
</a>
188+
</li>
189+
</ul>
188190

191+
</div>
189192
</div>
190-
</div>
191-
<div class="col-lg-6 col-lg-offset-2 col-sm-6">
192-
<pre><code class="language-js">
193+
<div class="col-lg-6 col-lg-offset-2 col-sm-6">
194+
<pre><code class="language-js">
193195
describe('01 function isAda', function () {
194196

195197
it('doesn\'t exist', function () {

‎_includes/docs/docs.html‎

Lines changed: 43 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,37 +12,56 @@ <h1 id="overview" class="page-header">Overview</h1>
1212
CodeRoad aims to make building & sharing interactive coding tutorials as easy as possible.
1313
</blockquote>
1414

15-
<div class="lead">We hope to create fun and maintainable code tutorials that actually improve with time. We hope to see programming students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive coding tutorials built.
16-
That's where you come in.</div>
15+
<div class="lead">We hope to create fun and maintainable code tutorials that actually improve with time. We hope to see programming students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some
16+
interactive coding tutorials built. That's where you come in.</div>
1717

18-
<a href="/build" class="btn btn-default btn-lg"><i class="fa fa-road fa-fw"></i> <span class="network-name">Read an Overview of Building a Tutorial</span></a>
18+
<a href="/build" class="btn btn-default btn-lg">
19+
<i class="fa fa-road fa-fw"></i>
20+
<span class="network-name">Read an Overview of Building a Tutorial</span>
21+
</a>
1922
<br><br>
2023
<div id="mc_embed_signup">
21-
<form class="form-inline" action="//herokuapp.us11.list-manage.com/subscribe/post?u=324732fa284e63ca555b47978&amp;id=5f3f4f5086" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
22-
<label class="sr-only" style="text-align:center">Subscribe to our mailing list</label>
23-
<div class="form-group">
24-
<input type="email" value="" class="form-control" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" style="font-family: Lato,Helvetica,Arial,sans-serif" required>
25-
<button type="submit" name="subscribe" id="mc-embedded-subscribe" class="btn btn-default">
26-
<i class="fa fa-envelope-o fa-fw"></i>
27-
<span class="network-name"> Subscribe To Mail List</span>
28-
</button>
29-
<!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
30-
<div style="position: absolute; left: -5000px;" aria-hidden="true">
31-
<input type="text" name="b_324732fa284e63ca555b47978_5f3f4f5086" tabindex="-1" value="">
32-
</div>
33-
</div>
34-
</form>
35-
</div>
24+
<form
25+
class="form-inline"
26+
action="//herokuapp.us11.list-manage.com/subscribe/post?u=324732fa284e63ca555b47978&amp;id=5f3f4f5086"
27+
method="post"
28+
id="mc-embedded-subscribe-form"
29+
name="mc-embedded-subscribe-form"
30+
class="validate"
31+
target="_blank"
32+
novalidate>
33+
<label class="sr-only" style="text-align:center">Subscribe to our mailing list</label>
34+
<div class="form-group">
35+
<input type="email" value="" class="form-control" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" style="font-family: Lato,Helvetica,Arial,sans-serif" required />
36+
<button type="submit" name="subscribe" id="mc-embedded-subscribe" class="btn btn-default">
37+
<i class="fa fa-envelope-o fa-fw"></i>
38+
<span class="network-name">
39+
Subscribe To Mail List</span>
40+
</button>
41+
<!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
42+
<div style="position: absolute; left: -5000px;" aria-hidden="true">
43+
<input type="text" name="b_324732fa284e63ca555b47978_5f3f4f5086" tabindex="-1" value="" />
44+
</div>
45+
</div>
46+
</form>
47+
</div>
3648
</section>
49+
3750
{% for post in site.posts reversed %}
38-
<section id="{{ post.id }}" class="bs-docs-section">
39-
<h2 class="section-heading">{{ post.title }}</h2>
40-
<div class="lead">{{ post.content }}</div>
51+
<section id="{{ post.id }}" class="bs-docs-section">
52+
<h2 class="section-heading">{{ post.title }}</h2>
53+
<div class="lead">{{ post.content }}</div>
54+
<br>
55+
<a href="https://github.com/coderoad/coderoad.github.io/edit/master/_posts/{{post.file}}" class="btn btn-default btn-xs">
56+
<i class="fa fa-pencil fa-fw"></i>
57+
<span class="network-name">
58+
Edit {{post.title}} Docs</span>
59+
</a>
60+
</section>
4161
<br>
42-
<a href="https://github.com/coderoad/coderoad.github.io/edit/master/_posts/{{ post.file}}" class="btn btn-default btn-xs"><i class="fa fa-pencil fa-fw"></i> <span class="network-name"> Edit {{post.title}} Docs</span></a>
43-
</section>
44-
<br> {% endfor %}
62+
{% endfor %}
4563
</div>
4664

4765
</div>
66+
</div>
4867
</section>

‎_includes/docs/header.html‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
<link rel="stylesheet" type="text/css" href="/css/docs.min.css" />
2-
<link rel="stylesheet" type="text/css" href="/css/dark-syntax.css" />
3-
41
<section id="build-home">
52
<!-- Header -->
63
<div class="short-intro-header">

‎_includes/docs/js.html‎

Lines changed: 67 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,84 @@
11
<script>
2-
$(function(){
3-
// build side menu
4-
var html = '';
2+
$(function () {
3+
// build side menu
4+
var html = '';
55

6-
$('.bs-docs-section').each(function() {
7-
var h1 = $(this).find('h1[id]').first(),
6+
$('.bs-docs-section').each(function () {
7+
var h1 = $(this).find('h1[id]').first(),
88
h23 = $(this).find('h2[id], h3[id]');
99

10-
if (h1.length) {
11-
html+= '<li><a href="#' + h1[0].id +'">'+ h1.clone().children().remove().end().text() +'</a>';
10+
if (h1.length) {
11+
html += '<li><a href="#' + h1[0].id + '">' + h1.clone().children().remove().end().text() + '</a>';
1212

13-
if (h23.length) {
14-
html+= '<ul class="nav">';
15-
h23.each(function() {
16-
html+= '<li><a href="#' + this.id +'">'+ $(this).clone().children().remove().end().text() +'</a></li>';
17-
});
18-
html+= '</ul>';
13+
if (h23.length) {
14+
html += '<ul class="nav">';
15+
h23.each(function () {
16+
html += '<li><a href="#' + this.id + '">' + $(this).clone().children().remove().end().text() + '</a></li>';
17+
});
18+
html += '</ul>';
19+
}
20+
21+
html += '</li>';
1922
}
23+
});
2024

21-
html+= '</li>';
25+
if (html == '') {
26+
$('[role=complementary]').hide();
27+
$('[role=main]').toggleClass('col-md-9 col-md-12');
28+
} else {
29+
$('.bs-docs-sidenav').html(html);
2230
}
23-
});
2431

25-
if (html == '') {
26-
$('[role=complementary]').hide();
27-
$('[role=main]').toggleClass('col-md-9 col-md-12');
28-
}
29-
else {
30-
$('.bs-docs-sidenav').html(html);
31-
}
32-
33-
$('[data-bootbox]').on('click', function() {
34-
var $target = $('#'+$(this).data('bootbox'));
35-
bootbox.alert({
36-
title: $target.attr('title'),
37-
message: $target.html()
32+
$('[data-bootbox]').on('click', function () {
33+
var $target = $('#' + $(this).data('bootbox'));
34+
bootbox.alert({title: $target.attr('title'), message: $target.html()});
3835
});
39-
});
4036

41-
/*!
37+
/*!
4238
* JavaScript for Bootstrap's docs (http://getbootstrap.com)
4339
* Copyright 2011-2014 Twitter, Inc.
4440
* Licensed under the Creative Commons Attribution 3.0 Unported License. For
4541
* details, see http://creativecommons.org/licenses/by/3.0/.
4642
*/
47-
!function(a){a(function(){if(navigator.userAgent.match(/IEMobile\/10\.0/)){var b=document.createElement("style");b.appendChild(document.createTextNode("@-ms-viewport{width:auto!important}")),document.querySelector("head").appendChild(b)}{var c=a(window),d=a(document.body);a(".navbar").outerHeight(!0)+10}d.scrollspy({target:".bs-docs-sidebar"}),c.on("load",function(){d.scrollspy("refresh")}),a(".bs-docs-container [href=#]").click(function(a){a.preventDefault()}),setTimeout(function(){var b=a(".bs-docs-sidebar");b.affix({offset:{top:function(){var c=b.offset().top,d=parseInt(b.children(0).css("margin-top"),10),e=a(".bs-docs-nav").height();return this.top=c-e-d},bottom:function(){return this.bottom=a(".bs-docs-footer").outerHeight(!0)}}})},100),setTimeout(function(){a(".bs-top").affix()},100)})}(jQuery);
48-
});
43+
!function (a) {
44+
a(function () {
45+
if (navigator.userAgent.match(/IEMobile\/10\.0/)) {
46+
var b = document.createElement("style");
47+
b.appendChild(document.createTextNode("@-ms-viewport{width:auto!important}")),
48+
document.querySelector("head").appendChild(b)
49+
}
50+
{
51+
var c = a(window),
52+
d = a(document.body);
53+
a(".navbar").outerHeight(!0) + 10
54+
}
55+
d.scrollspy({target: ".bs-docs-sidebar"}),
56+
c.on("load", function () {
57+
d.scrollspy("refresh")
58+
}),
59+
a(".bs-docs-container [href=#]").click(function (a) {
60+
a.preventDefault()
61+
}),
62+
setTimeout(function () {
63+
var b = a(".bs-docs-sidebar");
64+
b.affix({
65+
offset: {
66+
top: function () {
67+
var c = b.offset().top,
68+
d = parseInt(b.children(0).css("margin-top"), 10),
69+
e = a(".bs-docs-nav").height();
70+
return this.top = c - e - d
71+
},
72+
bottom: function () {
73+
return this.bottom = a(".bs-docs-footer").outerHeight(!0)
74+
}
75+
}
76+
})
77+
}, 100),
78+
setTimeout(function () {
79+
a(".bs-top").affix()
80+
}, 100)
81+
})
82+
}(jQuery);
83+
});
4984
</script>

‎_includes/docs/nav.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
<link rel="stylesheet" type="text/css" href="/css/docs.min.css"/>
2+
<link rel="stylesheet" type="text/css" href="/css/dark-syntax.css"/>
3+
14
<!-- Navigation -->
25
<nav class="navbar navbar-default navbar-collapse" role="navigation">
36
<div class="container">

‎_includes/head.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
<head>
22

3-
<meta charset="utf-8">
4-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
5-
<meta name="viewport" content="width=device-width, initial-scale=1">
6-
<meta name="description" content="{{ site.description }}">
7-
<meta name="author" content="{{ site.author }}">
3+
<meta charset="utf-8" />
4+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1" />
6+
<meta name="description" content="{{ site.description }}" />
7+
<meta name="author" content="{{ site.author }}" />
88
<meta name="google-site-verification" content="VJIgsbPgP-hRknYcXCVkjVBR0QZg6MaS-kpa9Gp0XY8" />
99
<meta name="msvalidate.01" content="1094FA9F7A148483624E60DBEE3DDC89" />
1010

1111
<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
1212

1313
<!-- Bootstrap Core CSS -->
14-
<link href="/css/bootstrap.min.css" rel="stylesheet">
14+
<link href="/css/bootstrap.min.css" rel="stylesheet" />
1515

1616
<!-- Custom CSS -->
17-
<link href="/css/landing-page.min.css" rel="stylesheet">
18-
<link href="/css/prism.min.css" rel="stylesheet">
17+
<link href="/css/landing-page.min.css" rel="stylesheet" />
18+
<link href="/css/prism.min.css" rel="stylesheet" />
1919

2020
<!-- Custom Fonts -->
21-
<link href="/css/font-awesome-4.1.0/css/font-awesome.min.css" rel="stylesheet" type="text/css">
22-
<link href="http://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic,700italic" rel="stylesheet" type="text/css">
21+
<link href="/css/font-awesome-4.1.0/css/font-awesome.min.css" rel="stylesheet" type="text/css" />
22+
<link href="http://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic,700italic" rel="stylesheet" type="text/css" />
2323
<link href="/fonts/firacode-webfont/FiraCode-Regular.css" rel="stylesheet" type="text/css" />
2424

2525
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->

0 commit comments

Comments
 (0)