Skip to content

Commit 61aab9c

Browse files
afshinmafshinm
committed
adding first version of documentation
1 parent cc18f56 commit 61aab9c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+28905
-0
lines changed

Diff for: ‎docs/_config.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Site settings
2+
title: Intro.js
3+
email: [email protected]
4+
author: "Afshin Mehrabani"
5+
description: "Intro.js - Better introductions for websites and features with a step-by-step guide for your projects."
6+
keywords: "intro, introjs, doc42, documentation, doc, usablica"
7+
8+
baseurl: "/docs" # the subpath of your doc, e.g. /doc
9+
url: "http://introjs.com" # the base hostname & protocol for your site
10+
twitter_username: usablica
11+
github_username: usablica
12+
13+
# use this to define the categories of your documentation
14+
category-list: [getting-started, intro, hints, themes, wrappers, developers, extra]
15+
# optionally you can define icon for each category (for the sidebar)
16+
# Doc42 uses Font Awesome
17+
category-icons: [gear, comments-o, info-circle, paint-brush, cubes, code, expand]
18+
19+
# Build settings
20+
markdown: kramdown

Diff for: ‎docs/_includes/footer.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<div class="grid">
2+
<div class="row">
3+
<footer class="basic menu top border animated fadeInUp">
4+
<div class="fluid">
5+
<a class="item" href="https://github.com/usablica/intro.js/blob/master/license.md">License</a>
6+
<a class="item" href="mailto:[email protected]">Contact</a>
7+
8+
<span class="right header item">&copy; {{ site.title | escape }} - Powered by <a href="http://doc42.io" target="_blank">Doc42</a></span>
9+
</div>
10+
</footer>
11+
</div>
12+
</div>
13+
14+
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.5.1/prism.min.js"></script>
15+
<script src="{{site.baseurl}}/js/contents.js"></script>
16+
<script src="{{site.baseurl}}/js/doc42.js"></script>
17+
<script src="{{site.baseurl}}/js/sticky.min.js"></script>

Diff for: ‎docs/_includes/head.html

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<head>
2+
<meta charset="utf-8">
3+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
4+
<meta name="viewport" content="width=device-width, initial-scale=1">
5+
6+
<title>{{ site.title | escape }} - {% if page.title %}{{ page.title | escape }}{% endif %}</title>
7+
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
8+
<meta name="keywords" content="{{ site.keywords }}">
9+
<meta name="author" content="{{ site.author }}">
10+
<meta name="generator" content="Doc42 0.1.0">
11+
12+
<link rel="stylesheet" href="{{ "/css/kissui.css" | prepend: site.baseurl }}">
13+
<link rel="stylesheet" href="{{ "/css/custom.css" | prepend: site.baseurl }}">
14+
<link rel="stylesheet" href="{{ "/css/sticky.min.css" | prepend: site.baseurl }}">
15+
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
16+
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}">
17+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.5.1/themes/prism.css">
18+
</head>

Diff for: ‎docs/_includes/header.html

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<div class="row">
2+
<header class="animated fadeIn" id="main_header">
3+
<nav class="basic border menu">
4+
<div class="fluid">
5+
<a class="header item" href="{{ site.baseurl }}/">
6+
{{ site.title }}
7+
</a>
8+
9+
<a class="item" href="/">Home</a>
10+
<a class="item" href="{{site.baseurl}}/">Documentation</a>
11+
<a class="item" href="https://github.com/usablica/introjs/releases" target="_blank">
12+
<i class="fa fa-download"></i> Download
13+
</a>
14+
<a class="item" href="https://github.com/usablica/introjs/" target="_blank">
15+
<i class="fa fa-github"></i> Github
16+
</a>
17+
<a class="item" href="{{site.baseurl}}/support" target="_blank">
18+
<i class="fa fa-support"></i> Support
19+
</a>
20+
</div>
21+
</nav>
22+
</header>
23+
</div>

Diff for: ‎docs/_includes/sidebar.html

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<nav class="basic border fluid vertical menu" data-kui-sticky>
2+
{% for cat in site.category-list %}
3+
4+
<div class="items">
5+
<div class="icon item header">
6+
<i class="fa fa-{{site.category-icons[forloop.index0]}}"></i>{{ cat | replace: "-", " " }}
7+
</div>
8+
{% assign pages = site.pages | sort:"weight" %}
9+
10+
{% for p in pages %}
11+
{% for pc in p.categories %}
12+
{% if pc == cat %}
13+
{% if page.permalink == p.url %}
14+
{% if page.table-of-content != nil %}
15+
<div class="secondary items">
16+
<div class="active item header">{{ p.title }}</div>
17+
{% for p in page.table-of-content %}
18+
<a class="item" href="#{{p | downcase | replace:' ','-' }}">{{p}}</a>
19+
{% endfor %}
20+
</div>
21+
{% else %}
22+
<span class="active item">{{ p.title }}</span>
23+
{% endif %}
24+
25+
{%else%}
26+
<a class="item" href="{{site.baseurl}}{{ p.url }}">{{ p.title }}</a>
27+
{% endif %}
28+
{% endif %}
29+
{% endfor %}
30+
{% endfor %}
31+
</div>
32+
{% endfor %}
33+
</nav>

Diff for: ‎docs/_includes/utils.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<script>
2+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
3+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
4+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
5+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
6+
7+
ga('create', 'UA-85887707-1', 'auto');
8+
ga('send', 'pageview');
9+
</script>

Diff for: ‎docs/_layouts/default.html

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!DOCTYPE html>
2+
<html>
3+
{% include head.html %}
4+
5+
<body>
6+
{% include header.html %}
7+
8+
<div class="fluid">
9+
<div class="wrapper">
10+
{{ content }}
11+
</div>
12+
</div>
13+
14+
{% include footer.html %}
15+
16+
{% include utils.html %}
17+
</body>
18+
</html>

Diff for: ‎docs/_layouts/doc.html

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: default
3+
---
4+
5+
<div class="row">
6+
<div class="two columns">
7+
{% include sidebar.html %}
8+
</div>
9+
10+
<div class="eight columns page-content">
11+
<header class="post-header">
12+
<h3 class="post-title">{{ page.title }}</h3>
13+
</header>
14+
15+
<div class="post-content docs">
16+
{{ content }}
17+
</div>
18+
</div>
19+
20+
<div id="contents" class="two columns">
21+
<div data-kui-sticky></div>
22+
</div>
23+
</div>

Diff for: ‎docs/_layouts/landing.html

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!DOCTYPE html>
2+
<html>
3+
{% include head.html %}
4+
5+
<body>
6+
{% include header.html %}
7+
8+
<div class="fluid">
9+
<div class="wrapper">
10+
{{ content }}
11+
</div>
12+
</div>
13+
14+
{% include utils.html %}
15+
</body>
16+
</html>

0 commit comments

Comments
 (0)