Skip to content

Commit

Permalink
Restructure and update docs for GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Borderliner committed Dec 9, 2016
1 parent 3ad3297 commit c3f75eb
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 36 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Meshki](http://meshki.borderliner.ir/)
# [Meshki](https://borderliner.github.io/Meshki/)
[![npm](https://img.shields.io/npm/dm/meshki.svg?maxAge=2592000?style=flat-square)](https://www.npmjs.com/package/meshki)
[![GitHub tag](https://img.shields.io/github/tag/borderliner/meshki.svg?maxAge=2592000?style=flat-square)](https://github.com/Borderliner/Meshki/releases)
[![npm](https://img.shields.io/npm/l/meshki.svg?maxAge=2592000?style=flat-square)](https://github.com/Borderliner/Meshki/blob/master/LICENSE.md)
Expand All @@ -7,7 +7,7 @@

Meshki is a simple, black-colored, responsive boilerplate to kickstart any responsive project.<br>
It is only <b>~18 KiB</b> (minified) and ~41 KiB (normal), including both CSS and JS files.<br>
Check out <http://meshki.borderliner.ir/> for samples and details.
Check out <https://borderliner.github.io/Meshki/> for samples and details.

## Getting Started

Expand Down Expand Up @@ -88,9 +88,9 @@ Meshki has been developed on a GNU/Linux system (Arch Linux and Ubuntu), using a

All parts of Meshki are free to use and abuse under the [open-source MIT license](https://github.com/Borderliner/Meshki/blob/master/LICENSE.md).<br>
All other non-Meshki codes have their own licenses. Check out their repositories for more information.
The website of [Meshki](http://meshki.borderliner.ir) uses [font-awesome](http://fontawesome.io/)
The website of [Meshki](https://borderliner.github.io/Meshki/) uses [font-awesome](http://fontawesome.io/)

## Acknowledgement

[Meshki](http://meshki.borderliner.ir) started by [Mohammad Reza Hajianpour](mailto:[email protected]) as a fork of [Skeleton](https://github.com/dhg/Skeleton). Although it has changed a lot, and Meshki has experienced a total overhaul.<br>
[Meshki](https://borderliner.github.io/Meshki/) started by [Mohammad Reza Hajianpour](mailto:[email protected]) as a fork of [Skeleton](https://github.com/dhg/Skeleton). Although it has changed a lot, and Meshki has experienced a total overhaul.<br>
Skeleton was created by [Dave Gamache](https://twitter.com/dhg).
1 change: 1 addition & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
- [x] Disable blue highlight on touch devices
- [x] Remove slider's knob animation
- [x] Add sharp class to sharpen elements
- [x] Host docs on GitHub for better accessibility

## v1.4.0
- [x] Fix navbar bottom padding overlaying the content
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "meshki",
"version": "1.4.0",
"homepage": "http://meshki.borderliner.ir/",
"homepage": "https://borderliner.github.io/Meshki/",
"repository": {
"type": "git",
"url": "https://github.com/Borderliner/Meshki"
Expand Down
Binary file added docs/favicon.ico
Binary file not shown.
24 changes: 12 additions & 12 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta property="og:title" content="Meshki UI"/>
<meta property="og:type" content="website"/>
<meta property="og:image" content="meta-image.png"/>
<meta property="og:url" content="http://meshki.borderliner.ir"/>
<meta property="og:url" content="https://borderliner.github.io/Meshki/"/>
<meta property="og:description" content="Meshki: A Black-Colored, Responsive Boilerplate for UI Development"/>
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@Meshki_UI">
Expand All @@ -19,14 +19,14 @@
<meta name="twitter:image" content="meta-image.png">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="../dist/meshki.min.css">
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki.min.css">
<link rel="stylesheet" type="text/css" href="custom.css">
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css">
<!--[if lt IE 9]>
<script src="https://cdnjs.cloudflare.com/ajax/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="shortcut icon" href="dist/favicon.ico" type="image/x-icon" />
<script type="text/javascript" src="../dist/meshki.min.js"></script>
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki.min.js"></script>
<script type="text/javascript" src="githubstars.js">

</script>
Expand All @@ -37,7 +37,7 @@
<a href="javascript:void(0);" class="sidenav-close-button" onclick="meshki.closeNav()">&times;</a>
<a href="">Home</a>
<a href="https://github.com/Borderliner/Meshki/issues">Issues</a>
<a href="https://www.npmjs.com/package/meshki">@npm</a>
<a href="https://www.npmjs.com/package/meshki">npm</a>
<a href="http://borderliner.ir/blog/">Blog</a>
<a href="https://github.com/Borderliner/Meshki/blob/master/README.md">About Meshki</a>
<hr class="hide-on-non-mobile">
Expand All @@ -55,9 +55,9 @@
<a href="https://twitter.com/Meshki_UI" class="twitter-follow-button" data-show-count="true">Follow @Meshki_UI</a><script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
<a href="javascript:void(0)" disabled style="font-size: 1.5rem">Share on:</a>
<div class="share-links">
<a href="https://www.facebook.com/sharer/sharer.php?u=http://meshki.borderliner.ir/" target="_blank"><i class="fa fa-facebook-square" aria-hidden="true"></i></a>
<a href="https://twitter.com/home?status=http://meshki.borderliner.ir/" target="_blank"><i class="fa fa-twitter-square" aria-hidden="true"></i></a>
<a href="https://plus.google.com/share?url=http://meshki.borderliner.ir/" target="_blank"><i class="fa fa-google-plus-square" aria-hidden="true"></i></a>
<a href="https://www.facebook.com/sharer/sharer.php?u=https://borderliner.github.io/Meshki/" target="_blank"><i class="fa fa-facebook-square" aria-hidden="true"></i></a>
<a href="https://twitter.com/home?status=https://borderliner.github.io/Meshki/" target="_blank"><i class="fa fa-twitter-square" aria-hidden="true"></i></a>
<a href="https://plus.google.com/share?url=https://borderliner.github.io/Meshki/" target="_blank"><i class="fa fa-google-plus-square" aria-hidden="true"></i></a>
</div>
</div>
<div class="content">
Expand All @@ -67,7 +67,7 @@
<li class="nav-dropdown hide-on-mobile">
<a href="javascript:void(0)" class="nav-dropdown-button">Plugins</a>
<div class="nav-dropdown-content">
<a href="index-rtl.html">RTL Mode (Persian)</a>
<a href="rtl/">RTL Mode (Persian)</a>
</div>
</li>
<li><a href="http://borderliner.ir/blog/tag/meshki/">News</a></li>
Expand Down Expand Up @@ -97,14 +97,14 @@ <h2 class="text-center">Stylish. Black. Responsive.</h2>

<div class="row text-center" style="margin-bottom: 250px;margin-top: 50px;">
<div class="button-couple">
<a class="button default large custom-down-cdn" href="https://github.com/Borderliner/Meshki/archive/v1.4.0.zip">Download (v1.4.0)</a>
<a class="button default large custom-down-cdn" href="https://github.com/Borderliner/Meshki/archive/v1.4.1.zip">Download (v1.4.1)</a>
<a class="button large disabled" disabled>or</a>
<a class="button danger large custom-down-cdn" href="javascript:void(0)" onclick="var cdn=document.getElementById('cdn');cdn.style.display=='none'?cdn.style.display='block':cdn.style.display='none';">Use CDN</a>
</div><br>
<pre id="cdn" style="display: none;">
<code>
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.0/meshki.min.css
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.0/meshki.min.js
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki.min.css
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki.min.js
</code>
</pre>
</div><br>
Expand Down
Binary file added docs/meta-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
36 changes: 18 additions & 18 deletions docs/index-rtl.html → docs/rtl/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,35 @@
<meta name="author" content="Mohammad reza Hajianpour">
<meta property="og:title" content="مشکی"/>
<meta property="og:type" content="website"/>
<meta property="og:image" content="meta-image.png"/>
<meta property="og:url" content="http://meshki.borderliner.ir"/>
<meta property="og:image" content="../meta-image.png"/>
<meta property="og:url" content="https://borderliner.github.io/Meshki/rtl"/>
<meta property="og:description" content="مشکی: کتابخانه سی‌اس‌اس، مخصوص طراحی صفحات زیبا و واکنشگرا"/>
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@Meshki_UI">
<meta name="twitter:title" content="Meshki UI">
<meta name="twitter:description" content="مشکی: کتابخانه سی‌اس‌اس، مخصوص طراحی صفحات زیبا و واکنشگرا">
<meta name="twitter:image" content="meta-image.png">
<meta name="twitter:image" content="../meta-image.png">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='http://awebfont.ir/css?id=1801' rel='stylesheet' type='text/css'>
<link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="../dist/meshki.min.css">
<link rel="stylesheet" type="text/css" href="../dist/meshki-rtl.min.css">
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki.min.css">
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki-rtl.min.css">
<link rel="stylesheet" type="text/css" href="custom-rtl.css">
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css">
<!--[if lt IE 9]>
<script src="https://cdnjs.cloudflare.com/ajax/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="shortcut icon" href="dist/favicon.ico" type="image/x-icon" />
<script type="text/javascript" src="../dist/meshki.min.js"></script>
<script type="text/javascript" src="githubstars.js"></script>
<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon" />
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki.min.js"></script>
<script type="text/javascript" src="../githubstars.js"></script>
</head>

<body class="">
<div class="sidenav push">
<a href="javascript:void(0);" class="sidenav-close-button" onclick="meshki.closeNav()">&times;</a>
<a href="">خانه</a>
<a href="https://github.com/Borderliner/Meshki/issues">ایرادات</a>
<a href="https://www.npmjs.com/package/meshki">@npm</a>
<a href="https://www.npmjs.com/package/meshki">npm</a>
<a href="http://borderliner.ir/blog/">وبلاگ</a>
<a href="https://github.com/Borderliner/Meshki/blob/master/README.md">درباره مشکی</a>
<hr class="hide-on-non-mobile">
Expand All @@ -55,9 +55,9 @@
<a href="https://twitter.com/Meshki_UI" class="twitter-follow-button" data-show-count="true">مشکی در توئیتر</a><script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
<a href="javascript:void(0)" disabled style="font-size: 1.5rem">اشتراک‌گذاری در:</a>
<div class="share-links">
<a href="https://www.facebook.com/sharer/sharer.php?u=http://meshki.borderliner.ir/" target="_blank"><i class="fa fa-facebook-square" aria-hidden="true"></i></a>
<a href="https://twitter.com/home?status=http://meshki.borderliner.ir/" target="_blank"><i class="fa fa-twitter-square" aria-hidden="true"></i></a>
<a href="https://plus.google.com/share?url=http://meshki.borderliner.ir/" target="_blank"><i class="fa fa-google-plus-square" aria-hidden="true"></i></a>
<a href="https://www.facebook.com/sharer/sharer.php?u=https://borderliner.github.io/Meshki/rtl/" target="_blank"><i class="fa fa-facebook-square" aria-hidden="true"></i></a>
<a href="https://twitter.com/home?status=https://borderliner.github.io/Meshki/rtl/" target="_blank"><i class="fa fa-twitter-square" aria-hidden="true"></i></a>
<a href="https://plus.google.com/share?url=https://borderliner.github.io/Meshki/rtl/" target="_blank"><i class="fa fa-google-plus-square" aria-hidden="true"></i></a>
</div>
</div>
<div class="content">
Expand All @@ -67,7 +67,7 @@
<li class="nav-dropdown hide-on-mobile">
<a href="javascript:void(0)" class="nav-dropdown-button">افزونه‌ها</a>
<div class="nav-dropdown-content">
<a href="index-rtl.html">چپ-به-راست (فارسی)</a>
<a href="/">چپ-به-راست (انگلیسی)</a>
</div>
</li>
<li><a href="http://borderliner.ir/blog/tag/meshki/">اخبار</a></li>
Expand Down Expand Up @@ -97,16 +97,16 @@ <h2 class="text-center">زیبا.  مشکی.  واکنش‌گرا.</h2>

<div class="row text-center" style="margin-bottom: 250px;margin-top: 50px;">
<div class="button-couple">
<a class="button default large custom-down-cdn" href="https://github.com/Borderliner/Meshki/archive/v1.4.0.zip">دانلود (نسخه 1.4.0)</a>
<a class="button default large custom-down-cdn" href="https://github.com/Borderliner/Meshki/archive/v1.4.1.zip">دانلود (نسخه 1.4.1)</a>
<a class="button large disabled" disabled>یا</a>
<a class="button danger large custom-down-cdn" href="javascript:void(0)" onclick="var cdn=document.getElementById('cdn');cdn.style.display=='none'?cdn.style.display='block':cdn.style.display='none';">استفاده از <span>CDN</span></a>
</div><br>
<pre id="cdn" style="display: none;">
<code>
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.0/meshki.min.css
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.0/meshki.min.js
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki.min.css
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki.min.js

https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.0/meshki-rtl.min.css
https://cdnjs.cloudflare.com/ajax/libs/meshki/1.4.1/meshki-rtl.min.css
</code>
</pre>
</div><br>
Expand Down Expand Up @@ -215,7 +215,7 @@ <h3>شروع به کار</h3>

<div class="row">
<figure class="twelve centerize text-center">
<img class="responsive" src="meshki_structure.png" />
<img class="responsive" src="../meshki_structure.png" />
<figcaption>
شکل بالا ساختار توصیه شده برای ساختن برنامه با مشکی را تشریح می‌کند.
</figcaption>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"bugs": {
"url": "https://github.com/Borderliner/Meshki/issues"
},
"homepage": "http://meshki.borderliner.ir/",
"homepage": "https://borderliner.github.io/Meshki/",
"devDependencies": {
"grunt": "^0.4.5",
"grunt-concat-css": "^0.3.1",
Expand Down

0 comments on commit c3f75eb

Please sign in to comment.