[go: nahoru, domu]

Skip to content
This repository has been archived by the owner on Jul 6, 2021. It is now read-only.

Markdown api docs #150

Merged
merged 11 commits into from
Mar 31, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
move files
  • Loading branch information
leobalter committed Mar 30, 2017
commit 9875dd56d4782f62cb9d0df44b9e66f142ff1302
File renamed without changes.
2 changes: 1 addition & 1 deletion main/QUnit.module.md → QUnit/module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: QUnit.module
title: module
description: Group related tests under a single label.
categories:
- main
Expand Down
2 changes: 1 addition & 1 deletion main/QUnit.only.md → QUnit/only.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: QUnit.only
title: only
description: Adds a test to exclusively run, preventing all other tests from running.
categories:
- main
Expand Down
2 changes: 1 addition & 1 deletion main/QUnit.skip.md → QUnit/skip.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: QUnit.skip
title: skip
description: Adds a test like object to be skipped
categories:
- main
Expand Down
2 changes: 1 addition & 1 deletion main/QUnit.start.md → QUnit/start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: QUnit.start
title: start
description: QUnit.start() is used to start an async test set
categories:
- main
Expand Down
2 changes: 1 addition & 1 deletion main/QUnit.test.md → QUnit/test.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: QUnit.test
title: test
description: Add a test to run.
categories:
- main
Expand Down
2 changes: 1 addition & 1 deletion main/QUnit.todo.md → QUnit/todo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: QUnit.todo
title: todo
description: Adds a test which expects at least one failing assertion during its run.
categories:
- main
Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ title: QUnit API Docs
# email: your-email@domain.com
description: > # this means to ignore newlines until "baseurl:"
API reference documentation for QUnit
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
baseurl: "/api" # the subpath of your site, e.g. /blog
url: "https://api.qunitjs.com" # the base hostname & protocol for your site, e.g. http://example.com
twitter_username: qunitjs
github_username: qunitjs

Expand Down
10 changes: 5 additions & 5 deletions _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ <h2>Main methods:</h2>
{% assign methods = site.pages | where:'categories', 'main' %}
{% for page in methods %}
<li class="sidebar-item">
<a href="{{page.url}}">{{page.title}}</a>
<a href="{{ page.url | prepend:site.baseurl }}">{{page.title}}</a>
</li>
{% endfor %}
</ul>
Expand All @@ -18,7 +18,7 @@ <h2>Assertions:</h2>
{% assign assertions = site.pages | where:'categories', 'assert' %}
{% for page in assertions %}
<li class="sidebar-item">
<a href="{{page.url}}">{{page.title}}</a>
<a href="{{ page.url | prepend:site.baseurl }}">{{page.title}}</a>
</li>
{% endfor %}
</ul>
Expand All @@ -29,7 +29,7 @@ <h2>Config:</h2>
{% assign config = site.pages | where:'categories', 'config' %}
{% for page in config %}
<li class="sidebar-item">
<a href="{{page.url}}">{{page.title}}</a>
<a href="{{ page.url | prepend:site.baseurl }}">{{page.title}}</a>
</li>
{% endfor %}
</ul>
Expand All @@ -40,7 +40,7 @@ <h2>Callbacks:</h2>
{% assign callbacks = site.pages | where:'categories', 'callbacks' %}
{% for page in callbacks %}
<li class="sidebar-item">
<a href="{{page.url}}">{{page.title}}</a>
<a href="{{ page.url | prepend:site.baseurl }}">{{page.title}}</a>
</li>
{% endfor %}
</ul>
Expand All @@ -51,7 +51,7 @@ <h2>Async control:</h2>
{% assign async = site.pages | where:'categories', 'async' %}
{% for page in async %}
<li class="sidebar-item">
<a href="{{page.url}}">{{page.title}}</a>
<a href="{{ page.url | prepend:site.baseurl }}">{{page.title}}</a>
</li>
{% endfor %}
</ul>
Expand Down
2 changes: 1 addition & 1 deletion _layouts/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ <h2>{{ page.title }}:</h2>
{% assign pages = site.pages | where:'categories', page.category %}
{% for page in pages %}
<li class="page-item">
<h3><a href="{{page.url}}">{{page.title}}</a></h3>
<h3><a href="{{ page.url | prepend:site.baseurl }}">{{page.title}}</a></h3>
<p>{{page.description}}</p>
</li>
{% endfor %}
Expand Down
8 changes: 4 additions & 4 deletions _layouts/wrapper.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,27 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{{ page.title }} | QUnit API Docs</title>
<link rel="icon" href="/favicon.ico">
<link rel="stylesheet" href="/css/styles.css" media="screen">
<link rel="stylesheet" href="{{ site.baseurl }}/css/styles.css" media="screen">
<meta name="twitter:creator" content="@qunitjs">
<meta name="twitter:site" content="@qunitjs">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:description" content="API reference documentation for QUnit">
<meta name="twitter:title" content="QUnit API Docs">
</head>
<body class="{{page.type}}">
<body class="{{ page.type }}">
<a class="a11y" href="#main">skip to content</a>
<div>
<header class="site-header" role="banner">
<div class="site-header-wrapper">
<div class="site-logo">
<h1 class="logo"><a class="logo-link" href="/">QUnit API Docs</a></h1>
<h1 class="logo"><a class="logo-link" href="{{ site.baseurl }}/">QUnit API Docs</a></h1>
</div>
<nav role="navigation" class="site-nav">
<ul class="site-nav-list">
{% assign topics = site.pages | where:'categories', 'topics' %}
{% for topic in topics %}
<li class="site-nav-list-item">
<a class="site-nav-list-link" href="{{ topic.url }}">
<a class="site-nav-list-link" href="{{ topic.url | prepend:site.baseurl }}">
{{ topic.title }}
</a>
</li>
Expand Down
2 changes: 1 addition & 1 deletion css/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ p {

a.logo-link:link,
a.logo-link:visited {
background: url('/img/logo-qunit@2x.png') no-repeat 0 0;
background: url('/api/img/logo-qunit@2x.png') no-repeat 0 0;
background-size: cover;
border: none;
display: block;
Expand Down