Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
/api-viewer/bower_components/
/api-viewer/node_modules/
_site
.sass-cache
generate/nodegit
node_modules/
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
source 'https://rubygems.org'
gem 'github-pages'
126 changes: 126 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
GEM
remote: https://rubygems.org/
specs:
RedCloth (4.2.9)
activesupport (4.2.0)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
blankslate (2.1.2.4)
celluloid (0.16.0)
timers (~> 4.0.0)
classifier-reborn (2.0.3)
fast-stemmer (~> 1.0)
coffee-script (2.3.0)
coffee-script-source
execjs
coffee-script-source (1.9.0)
colorator (0.1)
execjs (2.3.0)
fast-stemmer (1.0.2)
ffi (1.9.6)
gemoji (2.1.0)
github-pages (33)
RedCloth (= 4.2.9)
github-pages-health-check (~> 0.2)
jekyll (= 2.4.0)
jekyll-coffeescript (= 1.0.1)
jekyll-mentions (= 0.2.1)
jekyll-redirect-from (= 0.6.2)
jekyll-sass-converter (= 1.2.0)
jekyll-sitemap (= 0.6.3)
jemoji (= 0.4.0)
kramdown (= 1.5.0)
liquid (= 2.6.1)
maruku (= 0.7.0)
mercenary (~> 0.3)
pygments.rb (= 0.6.1)
rdiscount (= 2.1.7)
redcarpet (= 3.1.2)
terminal-table (~> 1.4)
github-pages-health-check (0.2.1)
net-dns (~> 0.6)
public_suffix (~> 1.4)
hitimes (1.2.2)
html-pipeline (1.9.0)
activesupport (>= 2)
nokogiri (~> 1.4)
i18n (0.7.0)
jekyll (2.4.0)
classifier-reborn (~> 2.0)
colorator (~> 0.1)
jekyll-coffeescript (~> 1.0)
jekyll-gist (~> 1.0)
jekyll-paginate (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 2.6.1)
mercenary (~> 0.3.3)
pygments.rb (~> 0.6.0)
redcarpet (~> 3.1)
safe_yaml (~> 1.0)
toml (~> 0.1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-gist (1.1.0)
jekyll-mentions (0.2.1)
html-pipeline (~> 1.9.0)
jekyll (~> 2.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.6.2)
jekyll (~> 2.0)
jekyll-sass-converter (1.2.0)
sass (~> 3.2)
jekyll-sitemap (0.6.3)
jekyll-watch (1.2.1)
listen (~> 2.7)
jemoji (0.4.0)
gemoji (~> 2.0)
html-pipeline (~> 1.9)
jekyll (~> 2.0)
json (1.8.2)
kramdown (1.5.0)
liquid (2.6.1)
listen (2.8.5)
celluloid (>= 0.15.2)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
maruku (0.7.0)
mercenary (0.3.5)
mini_portile (0.6.2)
minitest (5.5.1)
net-dns (0.8.0)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0)
parslet (1.5.0)
blankslate (~> 2.0)
posix-spawn (0.3.9)
public_suffix (1.4.6)
pygments.rb (0.6.1)
posix-spawn (~> 0.3.6)
yajl-ruby (~> 1.2.0)
rb-fsevent (0.9.4)
rb-inotify (0.9.5)
ffi (>= 0.5.0)
rdiscount (2.1.7)
redcarpet (3.1.2)
safe_yaml (1.0.4)
sass (3.4.11)
terminal-table (1.4.5)
thread_safe (0.3.4)
timers (4.0.1)
hitimes
toml (0.1.2)
parslet (~> 1.5.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
yajl-ruby (1.2.1)

PLATFORMS
ruby

DEPENDENCIES
github-pages
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
`bower install`
`http-server`
`script/bootstrap`
`script/server`
`open http://localhost:4000`

## Generating the site

While in development, the generator will not clone the nodegit repo. You'll need to soft-link the nodegit repository into `generate/`.

```bash
ln -s /path/to/nodegit generate/nodegit
```

Once linked, generate the site.

```bash
node generate
```

If you're running `script/server` in another terminal tab, it will read the changes and regenerate the site.
1 change: 0 additions & 1 deletion TODO.md

This file was deleted.

17 changes: 17 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Site settings
title: NodeGit
description: Asynchronous native Node bindings to libgit2
url: "http://nodegit.org"
date_format: "ordinal"
current_nodegit_version: 0.3.0
other_nodegit_versions:
- HEAD
- 0.2.7

# Build settings
markdown: redcarpet
redcarpet:
extensions: [tables, no_intra_emphasis, autolink]
highlighter: pygments
permalink: pretty
exclude: ["node_modules","generate","package.json","README.md"]
9 changes: 9 additions & 0 deletions _includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<footer class="site-footer">

<div class="wrapper">



</div>

</footer>
56 changes: 56 additions & 0 deletions _includes/head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">

<link rel="stylesheet" href="{{ "/css/main.css" | prepend: site.baseurl }}">
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
<link rel="alternate" type="application/atom+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="/js/sticky.js"></script>
<script>
var headlines = [];
$(function() {
$(".outline").stick_in_parent({offset_top:30});
$('a[name]').each(function() {
headlines.push({el: $(this), top:$(this).offset().top});
});

var selectHeadline = function() {
if (headlines.length) {
var top = $(window).scrollTop();
var headline = headlines[0].el;
for(var i=0;i<headlines.length;i++) {
if (headlines[i].top <= top + 30) {
headline = headlines[i].el;
}
}

var el = $("a[href='#" + headline.attr('name') + "']");
if (!el.hasClass('selected')) {
$('a[href^=#].selected').removeClass('selected');
el.addClass('selected');
}
}
}

$(window).on('scroll', selectHeadline);
selectHeadline();
});

$(document).on('click', 'a[href^=#]', function(e) {
var tag = $(e.currentTarget).attr('href').replace(/^#/, '');
var el = $("a[name='" + tag + "']");
$('html,body').animate({scrollTop: el.offset().top-30});
return false;
});

$(document).on('click', '.hamburger', function() {
$('.hamburger, nav').toggleClass('open');
})
</script>

</head>
52 changes: 52 additions & 0 deletions _includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<header class="site-header">

<div class="wrapper">

<div class="site-info">
<h1><a class="site-title" href="{{ site.baseurl }}/"><img src="/img/nodegit.svg" alt="{{ site.title }}" /></a></h1>
<div class="hamburger"></div>
<div class="version dropdown">
{% if page.nodegit_version %}
{{ page.nodegit_version }}
{% else %}
<span>Latest release:</span> {{ site.current_nodegit_version }}
{% endif %}
</div>
<ul class="version-menu">
<li><a href="{{ site.baseurl }}/"><span>Latest release:</span> {{ site.current_nodegit_version }}</a></li>
{% for version in site.other_nodegit_versions %}
<li><a href="{{ site.baseurl }}/{{version}}/">{{ version }}</a></li>
{% endfor %}
</ul>
</div>

<nav>
<ul>
<li{% if page.menu_item == 'getting_started' %} class="active"{% endif %}><a href="{{ site.baseurl }}/{% if page.nodegit_version %}{{ page.nodegit_version }}/{% endif %}">Getting Started</a></li>
<li{% if page.menu_item == 'guides' %} class="active"{% endif %}><a href="{{ site.baseurl }}/{% if page.nodegit_version %}{{ page.nodegit_version }}/{% endif %}guides/">Guides</a></li>
<li{% if page.menu_item == 'api' %} class="active"{% endif %}><a href="{{ site.baseurl }}/{% if page.nodegit_version %}{{ page.nodegit_version }}/{% endif %}api/">API Documentation</a></li>
<li><a href="https://github.com/nodegit/nodegit/{% if page.nodegit_version %}tree/{{ page.nodegit_version }}/{% endif %}">Source</a></li>
<!--<li{% if page.menu_item == 'blog' %} class="active"{% endif %}><a href="{{ site.baseurl }}/blog/">Blog</a></li>-->
</ul>
</nav>

</div>
</header>

<div class="banner">
{% if page.url == '/' %}
<div class="wrapper hero">
<h2>{{ site.description}}</h2>
<div class="buttons">
<a href="{{ site.baseurl }}/guides/">Read the NodeGit Guides</a>
<a href="https://github.com/nodegit/nodegit" class="secondary">Fork on GitHub</a>
</div>
<p>Latest release: {{ site.current_nodegit_version }} &mdash; <a href="{{ site.baseurl }}/changelog/">Changelog</a></p>
</div>
{% else %}
<div class="wrapper">
<h2>{{ page.title }}</h2>
<p>{{ page.description }}</p>
</div>
{% endif %}
</div>
34 changes: 34 additions & 0 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!DOCTYPE html>
<html>

{% include head.html %}

<body>

{% include header.html %}

<div class="page-content">
<div class="wrapper">
<div class="outline">
{% if page.return_to %}
{% for section_hash in page.return_to %}
<h5><a href="{{section_hash[1]}}">{{section_hash[0]}}</a></h5>
{% endfor %}
{% endif %}
<ul>
{% for section_hash in page.sections %}
<li><a href="{{section_hash[1]}}">{{section_hash[0]}}</a></li>
{% endfor %}
</ul>
</div>
<div class="main">
{{ content }}
</div>
</div>
</div>

{% include footer.html %}

</body>

</html>
23 changes: 23 additions & 0 deletions _layouts/full.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>

{% include head.html %}

<body>

{% include header.html %}

<div class="page-content">
<div class="wrapper">
<div class="main">
{{ content }}
</div>
</div>
</div>

{% include footer.html %}

</body>

</html>

12 changes: 12 additions & 0 deletions _layouts/guides.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: full
---

{% assign sections = page.content|split:'***' %}
<div class="guides">
{% for section in sections %}
<div class="document">
{{ section | markdownify }}
</div>
{% endfor %}
</div>
14 changes: 14 additions & 0 deletions _layouts/page.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: default
---
<div class="post">

<header class="post-header">
<h1 class="post-title">{{ page.title }}</h1>
</header>

<article class="post-content">
{{ content }}
</article>

</div>
Loading