Create gh-pages branch via GitHub

This commit is contained in:
Ilya Pirozhenko 2016-10-11 17:53:17 +03:00 committed by GitHub
commit f063c58a94
5 changed files with 1085 additions and 0 deletions

286
index.html Normal file
View file

@ -0,0 +1,286 @@
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Tlsharp by sochix</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
</head>
<body>
<section class="page-header">
<h1 class="project-name">Tlsharp</h1>
<h2 class="project-tagline">Telegram (http://telegram.org) client library implemented in C#. Waiting for contributors!</h2>
<a href="https://github.com/sochix/TLSharp" class="btn">View on GitHub</a>
<a href="https://github.com/sochix/TLSharp/zipball/master" class="btn">Download .zip</a>
<a href="https://github.com/sochix/TLSharp/tarball/master" class="btn">Download .tar.gz</a>
</section>
<section class="main-content">
<h1>
<a id="tlsharp" class="anchor" href="#tlsharp" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>TLSharp</h1>
<p><a href="https://gitter.im/TLSharp/Lobby?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://badges.gitter.im/TLSharp/Lobby.svg" alt="Join the chat at https://gitter.im/TLSharp/Lobby"></a>
<a href="https://ci.appveyor.com/project/sochix/tlsharp"><img src="https://ci.appveyor.com/api/projects/status/95rl618ch5c4h2fa?svg=true" alt="Build status"></a></p>
<p><em>Unofficial</em> Telegram (<a href="http://telegram.org">http://telegram.org</a>) client library implemented in C#. Latest TL scheme supported, thanks to Afshin Arani</p>
<p><strong>Consider donation to speed up development process.</strong> </p>
<p>Bitcoin wallet: <strong>3K1ocweFgaHnAibJ3n6hX7RNZWFTFcJjUe</strong></p>
<p>It's a perfect fit for any developer who would like to send data directly to Telegram users or write own custom Telegram client.</p>
<p><g-emoji alias="star2" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f31f.png" ios-version="6.0">🌟</g-emoji> If you <g-emoji alias="heart" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/2764.png" ios-version="6.0">❤️</g-emoji> library, please star it! <g-emoji alias="star2" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f31f.png" ios-version="6.0">🌟</g-emoji></p>
<h1>
<a id="table-of-contents" class="anchor" href="#table-of-contents" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Table of contents?</h1>
<ul>
<li><a href="#how-do-i-add-this-to-my-project">How do I add this to my project?</a></li>
<li><a href="#dependencies">Dependencies</a></li>
<li>
<a href="#starter-guide">Starter Guide</a>
<ul>
<li><a href="#quick-configuration">Quick configuration</a></li>
<li><a href="#first-requests">First requests</a></li>
</ul>
</li>
<li><a href="#available-methods">Available Methods</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#faq">FAQ</a></li>
<li><a href="#donations">Donations</a></li>
<li><a href="#license">License</a></li>
</ul>
<h1>
<a id="how-do-i-add-this-to-my-project" class="anchor" href="#how-do-i-add-this-to-my-project" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>How do I add this to my project?</h1>
<p>Library <em>almost</em> ready for production usage. We need contributors to make 1.0.0 release.</p>
<p>To use TLSharp follow next steps:</p>
<ol>
<li>Clone TLSharp from GitHub</li>
<li>Compile source with VS2015</li>
<li>Add reference to <code>TLSharp.Core.dll</code> to your awesome project.</li>
</ol>
<h1>
<a id="dependencies" class="anchor" href="#dependencies" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Dependencies</h1>
<p>TLSharp has a few dependenices, most of functionality implemented from scratch.
All dependencies listed in <a href="https://github.com/sochix/TLSharp/blob/master/TLSharp.Core/packages.config">package.conf file</a>.</p>
<h1>
<a id="starter-guide" class="anchor" href="#starter-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Starter Guide</h1>
<h2>
<a id="quick-configuration" class="anchor" href="#quick-configuration" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Quick Configuration</h2>
<p>Telegram API isn't that easy to start. You need to do some configuration first.</p>
<ol>
<li>Create a <a href="https://my.telegram.org/">developer account</a> in Telegram. </li>
<li>Goto <a href="https://my.telegram.org/apps">API development tools</a> and copy <strong>API_ID</strong> and <strong>API_HASH</strong> from your account. You'll need it later.</li>
</ol>
<h2>
<a id="first-requests" class="anchor" href="#first-requests" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>First requests</h2>
<p>To start work, create an instance of TelegramClient and establish connection</p>
<div class="highlight highlight-source-cs"><pre> <span class="pl-k">var</span> client = <span class="pl-k">new</span> TelegramClient(apiId, apiHash);
<span class="pl-k">await</span> client.ConnectAsync();</pre></div>
<p>Now you can work with Telegram API, but -&gt;</p>
<blockquote>
<p>Only a small portion of the API methods are available to unauthorized users. (<a href="https://core.telegram.org/api/auth">full description</a>) </p>
</blockquote>
<p>For authentication you need to run following code</p>
<div class="highlight highlight-source-cs"><pre> <span class="pl-k">var</span> hash = <span class="pl-k">await</span> client.SendCodeRequestAsync(<span class="pl-s"><span class="pl-pds">"</span>&lt;user_number&gt;<span class="pl-pds">"</span></span>);
<span class="pl-k">var</span> code = <span class="pl-s"><span class="pl-pds">"</span>&lt;code_from_telegram&gt;<span class="pl-pds">"</span></span>; <span class="pl-c">// you can change code in debugger</span>
<span class="pl-k">var</span> user = <span class="pl-k">await</span> client.MakeAuthAsync(<span class="pl-s"><span class="pl-pds">"</span>&lt;user_number&gt;<span class="pl-pds">"</span></span>, hash, code);</pre></div>
<p>Full code you can see at <a href="https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L70">AuthUser test</a></p>
<p>When user is authenticated, TLSharp creates special file called <em>session.dat</em>. In this file TLSharp store all information needed for user session. So you need to authenticate user every time the <em>session.dat</em> file is corrupted or removed.</p>
<p>You can call any method on authenticated user. For example, let's send message to a friend by his phone number:</p>
<div class="highlight highlight-source-cs"><pre> <span class="pl-c">//get available contacts</span>
<span class="pl-k">var</span> result = <span class="pl-k">await</span> client.GetContactsAsync();
<span class="pl-c">//find recipient in contacts</span>
<span class="pl-k">var</span> user = result.users.lists
.Where(x =&gt; x.GetType() == <span class="pl-k">typeof</span> (TLUser))
.Cast&lt;TLUser&gt;()
.FirstOrDefault(x =&gt; x.phone == <span class="pl-s"><span class="pl-pds">"</span>&lt;recipient_phone&gt;<span class="pl-pds">"</span></span>);
<span class="pl-c">//send message</span>
<span class="pl-k">await</span> client.SendMessageAsync(<span class="pl-k">new</span> TLInputPeerUser() {user_id = user.id}, <span class="pl-s"><span class="pl-pds">"</span>OUR_MESSAGE<span class="pl-pds">"</span></span>);</pre></div>
<p>Full code you can see at <a href="https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L87">SendMessage test</a></p>
<p>To send message to channel you could use the following code:</p>
<div class="highlight highlight-source-cs"><pre> <span class="pl-c">//get user dialogs</span>
<span class="pl-k">var</span> dialogs = <span class="pl-k">await</span> client.GetUserDialogsAsync();
<span class="pl-c">//find channel by title</span>
<span class="pl-k">var</span> chat = dialogs.chats.lists
.Where(c =&gt; c.GetType() == <span class="pl-k">typeof</span>(TLChannel))
.Cast&lt;TLChannel&gt;()
.FirstOrDefault(c =&gt; c.title == <span class="pl-s"><span class="pl-pds">"</span>&lt;channel_title&gt;<span class="pl-pds">"</span></span>);
<span class="pl-c">//send message</span>
<span class="pl-k">await</span> client.SendMessageAsync(<span class="pl-k">new</span> TLInputPeerChannel() { channel_id = chat.id, access_hash = chat.access_hash.Value }, <span class="pl-s"><span class="pl-pds">"</span>OUR_MESSAGE<span class="pl-pds">"</span></span>);</pre></div>
<p>Full code you can see at <a href="https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L107">SendMessageToChannel test</a></p>
<h2>
<a id="available-methods" class="anchor" href="#available-methods" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Available Methods</h2>
<p>For your convenience TLSharp have wrappers for several Telegram API methods. You could add your own, see details below.</p>
<ol>
<li>IsPhoneRegisteredAsync</li>
<li>SendCodeRequestAsync</li>
<li>MakeAuthAsync</li>
<li>SignUpAsync</li>
<li>GetContactsAsync</li>
<li>SendMessageAsync</li>
<li>SendTypingAsync</li>
<li>GetUserDialogsAsync</li>
</ol>
<p><strong>What if you can't find needed method at the list?</strong></p>
<p>Don't panic. You can call any method with help of <code>SendRequestAsync</code> function. For example, send user typing method: </p>
<div class="highlight highlight-source-cs"><pre>
<span class="pl-c">//Create request </span>
<span class="pl-k">var</span> req = <span class="pl-k">new</span> TLRequestSetTyping()
{
action = <span class="pl-k">new</span> TLSendMessageTypingAction(),
peer = peer
};
<span class="pl-c">//run request, and deserialize response to Boolean</span>
<span class="pl-k">return</span> <span class="pl-k">await</span> SendRequestAsync&lt;Boolean&gt;(req);</pre></div>
<p><strong>Where you can find a list of requests and its params?</strong></p>
<p>The only way is <a href="https://core.telegram.org/methods">Telegram API docs</a>. Yes, it's outdated. But there is no other source.</p>
<h2>
<a id="contributing" class="anchor" href="#contributing" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contributing</h2>
<p>Contributing is highly appreciated!</p>
<h3>
<a id="what-things-can-i-implement-project-roadmap" class="anchor" href="#what-things-can-i-implement-project-roadmap" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>What things can I Implement (Project Roadmap)?</h3>
<ul>
<li>Add Updates handling</li>
<li>Add NuGet package</li>
<li>Add wrappers for media uploading</li>
<li>Store user session as JSON</li>
</ul>
<h1>
<a id="faq" class="anchor" href="#faq" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>FAQ</h1>
<h4>
<a id="what-api-layer-is-supported" class="anchor" href="#what-api-layer-is-supported" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>What API layer is supported?</h4>
<p>The latest one - 53. Thanks to Afshin Arani</p>
<h4>
<a id="i-get-an-error-migrate_x" class="anchor" href="#i-get-an-error-migrate_x" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>I get an error MIGRATE_X?</h4>
<p>TLSharp library should automatically handle this errors. If you see such errors, pls create a new issue.</p>
<h4>
<a id="i-get-an-exception-systemioendofstreamexception-unable-to-read-beyond-the-end-of-the-stream-all-test-methos-except-that-authenticationworks-and-testconnection-return-same-error-i-did-every-thing-including-setting-api-id-and-hash-and-setting-server-address-" class="anchor" href="#i-get-an-exception-systemioendofstreamexception-unable-to-read-beyond-the-end-of-the-stream-all-test-methos-except-that-authenticationworks-and-testconnection-return-same-error-i-did-every-thing-including-setting-api-id-and-hash-and-setting-server-address-" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>I get an exception: System.IO.EndOfStreamException: Unable to read beyond the end of the stream. All test methos except that AuthenticationWorks and TestConnection return same error. I did every thing including setting api id and hash, and setting server address.-</h4>
<p>You should create a Telegram session. See <a href="#sending-messages-set-up">configuration guide</a></p>
<h4>
<a id="why-i-get-flood_wait-error" class="anchor" href="#why-i-get-flood_wait-error" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Why I get FLOOD_WAIT error?</h4>
<p><a href="https://core.telegram.org/api/errors#420-flood">It's Telegram restrictions</a></p>
<h4>
<a id="why-does-tlsharp-lacks-feature-xxxx" class="anchor" href="#why-does-tlsharp-lacks-feature-xxxx" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Why does TLSharp lacks feature XXXX?</h4>
<p>Now TLSharp is basic realization of Telegram protocol, you can be a contributor or a sponsor to speed-up developemnt of any feature.</p>
<h4>
<a id="nothing-helps" class="anchor" href="#nothing-helps" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Nothing helps</h4>
<p>Ask your question at gitter or create an issue in project bug tracker.</p>
<p><strong>Attach following information</strong>:</p>
<ul>
<li>Full problem description and exception message</li>
<li>Stack-trace</li>
<li>Your code that runs in to this exception</li>
</ul>
<p>Without information listen above your issue will be closed. </p>
<h1>
<a id="donations" class="anchor" href="#donations" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Donations</h1>
<p>Thanks for donations! It's highly appreciated.
Bitcoin wallet: <strong>3K1ocweFgaHnAibJ3n6hX7RNZWFTFcJjUe</strong></p>
<p>List of donators:</p>
<ul>
<li><a href="https://github.com/mtbitcoin">mtbitcoin</a></li>
</ul>
<h1>
<a id="contributors" class="anchor" href="#contributors" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contributors</h1>
<ul>
<li>
<a href="http://aarani.ir">Afshin Arani</a> - TLGenerator, and a lot of other usefull things</li>
</ul>
<h1>
<a id="license" class="anchor" href="#license" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>License</h1>
<p><strong>Please, provide link to an author when you using library</strong></p>
<p>The MIT License</p>
<p>Copyright (c) 2015 Ilya Pirozhenko <a href="http://www.sochix.ru/">http://www.sochix.ru/</a></p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<footer class="site-footer">
<span class="site-footer-owner"><a href="https://github.com/sochix/TLSharp">Tlsharp</a> is maintained by <a href="https://github.com/sochix">sochix</a>.</span>
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span>
</footer>
</section>
</body>
</html>

6
params.json Normal file

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,124 @@
/*
The MIT License (MIT)
Copyright (c) 2016 GitHub, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
.pl-c /* comment */ {
color: #969896;
}
.pl-c1 /* constant, variable.other.constant, support, meta.property-name, support.constant, support.variable, meta.module-reference, markup.raw, meta.diff.header */,
.pl-s .pl-v /* string variable */ {
color: #0086b3;
}
.pl-e /* entity */,
.pl-en /* entity.name */ {
color: #795da3;
}
.pl-smi /* variable.parameter.function, storage.modifier.package, storage.modifier.import, storage.type.java, variable.other */,
.pl-s .pl-s1 /* string source */ {
color: #333;
}
.pl-ent /* entity.name.tag */ {
color: #63a35c;
}
.pl-k /* keyword, storage, storage.type */ {
color: #a71d5d;
}
.pl-s /* string */,
.pl-pds /* punctuation.definition.string, string.regexp.character-class */,
.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
.pl-sr /* string.regexp */,
.pl-sr .pl-cce /* string.regexp constant.character.escape */,
.pl-sr .pl-sre /* string.regexp source.ruby.embedded */,
.pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */ {
color: #183691;
}
.pl-v /* variable */ {
color: #ed6a43;
}
.pl-id /* invalid.deprecated */ {
color: #b52a1d;
}
.pl-ii /* invalid.illegal */ {
color: #f8f8f8;
background-color: #b52a1d;
}
.pl-sr .pl-cce /* string.regexp constant.character.escape */ {
font-weight: bold;
color: #63a35c;
}
.pl-ml /* markup.list */ {
color: #693a17;
}
.pl-mh /* markup.heading */,
.pl-mh .pl-en /* markup.heading entity.name */,
.pl-ms /* meta.separator */ {
font-weight: bold;
color: #1d3e81;
}
.pl-mq /* markup.quote */ {
color: #008080;
}
.pl-mi /* markup.italic */ {
font-style: italic;
color: #333;
}
.pl-mb /* markup.bold */ {
font-weight: bold;
color: #333;
}
.pl-md /* markup.deleted, meta.diff.header.from-file */ {
color: #bd2c00;
background-color: #ffecec;
}
.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
color: #55a532;
background-color: #eaffea;
}
.pl-mdr /* meta.diff.range */ {
font-weight: bold;
color: #795da3;
}
.pl-mo /* meta.output */ {
color: #1d3e81;
}

424
stylesheets/normalize.css vendored Normal file
View file

@ -0,0 +1,424 @@
/*! normalize.css v3.0.2 | MIT License | git.io/normalize */
/**
* 1. Set default font family to sans-serif.
* 2. Prevent iOS text size adjust after orientation change, without disabling
* user zoom.
*/
html {
font-family: sans-serif; /* 1 */
-ms-text-size-adjust: 100%; /* 2 */
-webkit-text-size-adjust: 100%; /* 2 */
}
/**
* Remove default margin.
*/
body {
margin: 0;
}
/* HTML5 display definitions
========================================================================== */
/**
* Correct `block` display not defined for any HTML5 element in IE 8/9.
* Correct `block` display not defined for `details` or `summary` in IE 10/11
* and Firefox.
* Correct `block` display not defined for `main` in IE 11.
*/
article,
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
main,
menu,
nav,
section,
summary {
display: block;
}
/**
* 1. Correct `inline-block` display not defined in IE 8/9.
* 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
*/
audio,
canvas,
progress,
video {
display: inline-block; /* 1 */
vertical-align: baseline; /* 2 */
}
/**
* Prevent modern browsers from displaying `audio` without controls.
* Remove excess height in iOS 5 devices.
*/
audio:not([controls]) {
display: none;
height: 0;
}
/**
* Address `[hidden]` styling not present in IE 8/9/10.
* Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
*/
[hidden],
template {
display: none;
}
/* Links
========================================================================== */
/**
* Remove the gray background color from active links in IE 10.
*/
a {
background-color: transparent;
}
/**
* Improve readability when focused and also mouse hovered in all browsers.
*/
a:active,
a:hover {
outline: 0;
}
/* Text-level semantics
========================================================================== */
/**
* Address styling not present in IE 8/9/10/11, Safari, and Chrome.
*/
abbr[title] {
border-bottom: 1px dotted;
}
/**
* Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
*/
b,
strong {
font-weight: bold;
}
/**
* Address styling not present in Safari and Chrome.
*/
dfn {
font-style: italic;
}
/**
* Address variable `h1` font-size and margin within `section` and `article`
* contexts in Firefox 4+, Safari, and Chrome.
*/
h1 {
font-size: 2em;
margin: 0.67em 0;
}
/**
* Address styling not present in IE 8/9.
*/
mark {
background: #ff0;
color: #000;
}
/**
* Address inconsistent and variable font size in all browsers.
*/
small {
font-size: 80%;
}
/**
* Prevent `sub` and `sup` affecting `line-height` in all browsers.
*/
sub,
sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline;
}
sup {
top: -0.5em;
}
sub {
bottom: -0.25em;
}
/* Embedded content
========================================================================== */
/**
* Remove border when inside `a` element in IE 8/9/10.
*/
img {
border: 0;
}
/**
* Correct overflow not hidden in IE 9/10/11.
*/
svg:not(:root) {
overflow: hidden;
}
/* Grouping content
========================================================================== */
/**
* Address margin not present in IE 8/9 and Safari.
*/
figure {
margin: 1em 40px;
}
/**
* Address differences between Firefox and other browsers.
*/
hr {
box-sizing: content-box;
height: 0;
}
/**
* Contain overflow in all browsers.
*/
pre {
overflow: auto;
}
/**
* Address odd `em`-unit font size rendering in all browsers.
*/
code,
kbd,
pre,
samp {
font-family: monospace, monospace;
font-size: 1em;
}
/* Forms
========================================================================== */
/**
* Known limitation: by default, Chrome and Safari on OS X allow very limited
* styling of `select`, unless a `border` property is set.
*/
/**
* 1. Correct color not being inherited.
* Known issue: affects color of disabled elements.
* 2. Correct font properties not being inherited.
* 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
*/
button,
input,
optgroup,
select,
textarea {
color: inherit; /* 1 */
font: inherit; /* 2 */
margin: 0; /* 3 */
}
/**
* Address `overflow` set to `hidden` in IE 8/9/10/11.
*/
button {
overflow: visible;
}
/**
* Address inconsistent `text-transform` inheritance for `button` and `select`.
* All other form control elements do not inherit `text-transform` values.
* Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
* Correct `select` style inheritance in Firefox.
*/
button,
select {
text-transform: none;
}
/**
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
* and `video` controls.
* 2. Correct inability to style clickable `input` types in iOS.
* 3. Improve usability and consistency of cursor style between image-type
* `input` and others.
*/
button,
html input[type="button"], /* 1 */
input[type="reset"],
input[type="submit"] {
-webkit-appearance: button; /* 2 */
cursor: pointer; /* 3 */
}
/**
* Re-set default cursor for disabled elements.
*/
button[disabled],
html input[disabled] {
cursor: default;
}
/**
* Remove inner padding and border in Firefox 4+.
*/
button::-moz-focus-inner,
input::-moz-focus-inner {
border: 0;
padding: 0;
}
/**
* Address Firefox 4+ setting `line-height` on `input` using `!important` in
* the UA stylesheet.
*/
input {
line-height: normal;
}
/**
* It's recommended that you don't attempt to style these elements.
* Firefox's implementation doesn't respect box-sizing, padding, or width.
*
* 1. Address box sizing set to `content-box` in IE 8/9/10.
* 2. Remove excess padding in IE 8/9/10.
*/
input[type="checkbox"],
input[type="radio"] {
box-sizing: border-box; /* 1 */
padding: 0; /* 2 */
}
/**
* Fix the cursor style for Chrome's increment/decrement buttons. For certain
* `font-size` values of the `input`, it causes the cursor style of the
* decrement button to change from `default` to `text`.
*/
input[type="number"]::-webkit-inner-spin-button,
input[type="number"]::-webkit-outer-spin-button {
height: auto;
}
/**
* 1. Address `appearance` set to `searchfield` in Safari and Chrome.
* 2. Address `box-sizing` set to `border-box` in Safari and Chrome
* (include `-moz` to future-proof).
*/
input[type="search"] {
-webkit-appearance: textfield; /* 1 */ /* 2 */
box-sizing: content-box;
}
/**
* Remove inner padding and search cancel button in Safari and Chrome on OS X.
* Safari (but not Chrome) clips the cancel button when the search input has
* padding (and `textfield` appearance).
*/
input[type="search"]::-webkit-search-cancel-button,
input[type="search"]::-webkit-search-decoration {
-webkit-appearance: none;
}
/**
* Define consistent border, margin, and padding.
*/
fieldset {
border: 1px solid #c0c0c0;
margin: 0 2px;
padding: 0.35em 0.625em 0.75em;
}
/**
* 1. Correct `color` not being inherited in IE 8/9/10/11.
* 2. Remove padding so people aren't caught out if they zero out fieldsets.
*/
legend {
border: 0; /* 1 */
padding: 0; /* 2 */
}
/**
* Remove default vertical scrollbar in IE 8/9/10/11.
*/
textarea {
overflow: auto;
}
/**
* Don't inherit the `font-weight` (applied by a rule above).
* NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
*/
optgroup {
font-weight: bold;
}
/* Tables
========================================================================== */
/**
* Remove most spacing between table cells.
*/
table {
border-collapse: collapse;
border-spacing: 0;
}
td,
th {
padding: 0;
}

245
stylesheets/stylesheet.css Normal file
View file

@ -0,0 +1,245 @@
* {
box-sizing: border-box; }
body {
padding: 0;
margin: 0;
font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
font-size: 16px;
line-height: 1.5;
color: #606c71; }
a {
color: #1e6bb8;
text-decoration: none; }
a:hover {
text-decoration: underline; }
.btn {
display: inline-block;
margin-bottom: 1rem;
color: rgba(255, 255, 255, 0.7);
background-color: rgba(255, 255, 255, 0.08);
border-color: rgba(255, 255, 255, 0.2);
border-style: solid;
border-width: 1px;
border-radius: 0.3rem;
transition: color 0.2s, background-color 0.2s, border-color 0.2s; }
.btn + .btn {
margin-left: 1rem; }
.btn:hover {
color: rgba(255, 255, 255, 0.8);
text-decoration: none;
background-color: rgba(255, 255, 255, 0.2);
border-color: rgba(255, 255, 255, 0.3); }
@media screen and (min-width: 64em) {
.btn {
padding: 0.75rem 1rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.btn {
padding: 0.6rem 0.9rem;
font-size: 0.9rem; } }
@media screen and (max-width: 42em) {
.btn {
display: block;
width: 100%;
padding: 0.75rem;
font-size: 0.9rem; }
.btn + .btn {
margin-top: 1rem;
margin-left: 0; } }
.page-header {
color: #fff;
text-align: center;
background-color: #159957;
background-image: linear-gradient(120deg, #155799, #159957); }
@media screen and (min-width: 64em) {
.page-header {
padding: 5rem 6rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.page-header {
padding: 3rem 4rem; } }
@media screen and (max-width: 42em) {
.page-header {
padding: 2rem 1rem; } }
.project-name {
margin-top: 0;
margin-bottom: 0.1rem; }
@media screen and (min-width: 64em) {
.project-name {
font-size: 3.25rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.project-name {
font-size: 2.25rem; } }
@media screen and (max-width: 42em) {
.project-name {
font-size: 1.75rem; } }
.project-tagline {
margin-bottom: 2rem;
font-weight: normal;
opacity: 0.7; }
@media screen and (min-width: 64em) {
.project-tagline {
font-size: 1.25rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.project-tagline {
font-size: 1.15rem; } }
@media screen and (max-width: 42em) {
.project-tagline {
font-size: 1rem; } }
.main-content :first-child {
margin-top: 0; }
.main-content img {
max-width: 100%; }
.main-content h1, .main-content h2, .main-content h3, .main-content h4, .main-content h5, .main-content h6 {
margin-top: 2rem;
margin-bottom: 1rem;
font-weight: normal;
color: #159957; }
.main-content p {
margin-bottom: 1em; }
.main-content code {
padding: 2px 4px;
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 0.9rem;
color: #383e41;
background-color: #f3f6fa;
border-radius: 0.3rem; }
.main-content pre {
padding: 0.8rem;
margin-top: 0;
margin-bottom: 1rem;
font: 1rem Consolas, "Liberation Mono", Menlo, Courier, monospace;
color: #567482;
word-wrap: normal;
background-color: #f3f6fa;
border: solid 1px #dce6f0;
border-radius: 0.3rem; }
.main-content pre > code {
padding: 0;
margin: 0;
font-size: 0.9rem;
color: #567482;
word-break: normal;
white-space: pre;
background: transparent;
border: 0; }
.main-content .highlight {
margin-bottom: 1rem; }
.main-content .highlight pre {
margin-bottom: 0;
word-break: normal; }
.main-content .highlight pre, .main-content pre {
padding: 0.8rem;
overflow: auto;
font-size: 0.9rem;
line-height: 1.45;
border-radius: 0.3rem; }
.main-content pre code, .main-content pre tt {
display: inline;
max-width: initial;
padding: 0;
margin: 0;
overflow: initial;
line-height: inherit;
word-wrap: normal;
background-color: transparent;
border: 0; }
.main-content pre code:before, .main-content pre code:after, .main-content pre tt:before, .main-content pre tt:after {
content: normal; }
.main-content ul, .main-content ol {
margin-top: 0; }
.main-content blockquote {
padding: 0 1rem;
margin-left: 0;
color: #819198;
border-left: 0.3rem solid #dce6f0; }
.main-content blockquote > :first-child {
margin-top: 0; }
.main-content blockquote > :last-child {
margin-bottom: 0; }
.main-content table {
display: block;
width: 100%;
overflow: auto;
word-break: normal;
word-break: keep-all; }
.main-content table th {
font-weight: bold; }
.main-content table th, .main-content table td {
padding: 0.5rem 1rem;
border: 1px solid #e9ebec; }
.main-content dl {
padding: 0; }
.main-content dl dt {
padding: 0;
margin-top: 1rem;
font-size: 1rem;
font-weight: bold; }
.main-content dl dd {
padding: 0;
margin-bottom: 1rem; }
.main-content hr {
height: 2px;
padding: 0;
margin: 1rem 0;
background-color: #eff0f1;
border: 0; }
@media screen and (min-width: 64em) {
.main-content {
max-width: 64rem;
padding: 2rem 6rem;
margin: 0 auto;
font-size: 1.1rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.main-content {
padding: 2rem 4rem;
font-size: 1.1rem; } }
@media screen and (max-width: 42em) {
.main-content {
padding: 2rem 1rem;
font-size: 1rem; } }
.site-footer {
padding-top: 2rem;
margin-top: 2rem;
border-top: solid 1px #eff0f1; }
.site-footer-owner {
display: block;
font-weight: bold; }
.site-footer-credits {
color: #819198; }
@media screen and (min-width: 64em) {
.site-footer {
font-size: 1rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.site-footer {
font-size: 1rem; } }
@media screen and (max-width: 42em) {
.site-footer {
font-size: 0.9rem; } }