Skip to content

Commit

Permalink
Documentation: improve design
Browse files Browse the repository at this point in the history
  • Loading branch information
olivierapivideo authored Sep 1, 2023
1 parent d7cfd57 commit 1850d92
Show file tree
Hide file tree
Showing 24 changed files with 442 additions and 186 deletions.
128 changes: 46 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,15 @@ meta:

<div class="hero">

### New to api.video?

# Get started [here](/get-started/start-building.md)!

<!-- These are just example buttons, we can remove them:
<div class="links">
[Register for free](https://dashboard.api.video/register)
# api.video *documentation*
</div>

</div> -->

<div class="section-header">
<hr/>

### New to api.video?
## Get started [here](/get-started/start-building.md)!
</div>

Welcome to the developer documentation of api.video! Our platform empowers developers and businesses to seamlessly integrate video functionality into their applications and services. Whether you're looking to offer video on demand, live streaming, or leverage our player and analytics features, the api.video API is designed to simplify the process.
Expand All @@ -31,17 +28,13 @@ Check out the products:

api.video's hosting service enables users to upload and store videos, which can then be easily delivered and shared across various devices and platforms.

<br>

{% endcapture %}

{% capture live-stream-description %}

api.video provides you with the possibility to embed live streaming into your application or project seamlessly.

<br>

<br>

{% endcapture %}

Expand All @@ -51,89 +44,60 @@ api.video lets you customize a large part of the delivery, whether it's the play

<br>

<br>

{% endcapture %}

{% include "_partials/vod-product-grid-item.md" product: "Video", subheading: "on demand", description: vod-description, link: "/vod/README.md" %}
{% include "_partials/live-stream-product-grid-item.md" product: "Live", subheading: "streaming", description: live-stream-description, link: "/live-streaming/README.md" %}
{% include "_partials/player-analytics-product-grid-item.md" product: "Player", subheading: "& analytics", description: player-analytics-description, link: "/delivery-analytics/README.md" %}
{% include "_partials/product-grid-item.md" product: "Video", subheading: "on demand", description: vod-description, link: "/vod/README.md" %}
{% include "_partials/product-grid-item.md" product: "Live", subheading: "streaming", description: live-stream-description, link: "/live-streaming/README.md" %}
{% include "_partials/product-grid-item.md" product: "Player", subheading: "& analytics", description: player-analytics-description, link: "/delivery-analytics/README.md" %}

</div>

<br>

# Start working with api.video
<div class="section-header">
<hr/>

<div class="quick-links">
### Section header
## Quick links
</div>

{% capture quick-link-table-item-1-description %}

This is where the quick links table will go.

<div class="quick-links-grid">
{% capture get-started-links %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "Start working with api.video", link: "/" %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "Video quickstart", link: "/" %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "Live streaming quickstart", link: "/" %}
{% endcapture %}

{% include "_partials/quick-link-item.md" table-name: "Quick links", description: quick-link-table-item-1-description, link: "/vod/get-started-in-5-minutes.md" %}
{% include "_partials/quick-link-item.md" table-name: "Quick links", description: quick-link-table-item-1-description, link: "/vod/get-started-in-5-minutes.md" %}
{% capture sdks-and-plugins %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "SDK", link: "/" %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "SDK", link: "/" %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "SDK", link: "/" %}
{% endcapture %}

</div>
{% capture understand-api-video %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "SDK", link: "/" %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "SDK", link: "/" %}
{% include "_partials/quick-links-grid-item-line.md" icon: "/_assets/icons/js.svg", label: "SDK", link: "/" %}
{% endcapture %}

<br>

# Need help?

<!-- Support cards, CSS should be moved to _assets/style.css -->

<div style="display: flex; flex-direction: row; flex-wrap: wrap; gap: 40px">
<a href="https://help.api.video/en/" target="_self" style="text-decoration: none">

<div
style="
display: flex;
align-items: center;
gap: 24px;
padding: 36px;
width: 472px;
height: 104px;
border-radius: 4px;
background: #fff;
box-shadow: 0px 20px 50px 0 rgba(59, 43, 92, 0.1);
"
>
<div
style="
background-color: #e9dded;
width: 56px;
height: 56px;
border-radius: 2px;
display: flex;
justify-content: center;
align-items: center;
"
>
<div style="width: 32px; height: 32px">
<img
style="object-fit: contain; width: 100%; height: 100%"
src="https://img.api.video/help_center_black_ec703b4744.svg"
alt="logo help center"
/>
</div>
{% include "_partials/quick-links-grid-item.md" name: "getting-started", title: "Get Started", content: get-started-links %}
{% include "_partials/quick-links-grid-item.md" name: "sdks", title: "SDKs and plugins", content: sdks-and-plugins %}
{% include "_partials/quick-links-grid-item.md" name: "understand", title: "Understand api.video", content: understand-api-video %}

</div>
<span
style="
font-size: 18px;
font-weight: 600;
text-align: left;
color: #414f6e;
flex: 1;
"
>
Browse the Help Center
</span>
<img
style="width: 24px; height: 24px"
src="https://img.api.video/arrow_forward_ios_6206f171e8.svg"
alt="logo arrow"
/>


<div class="section-header">
<hr/>

### Section header
## Need help?
</div>
</a>


<div class="need-help-buttons">
{% include "_partials/need-help-button.md" label: "Browse help center", icon: "/_assets/icons/js.svg", link: "/" %}
{% include "_partials/need-help-button.md" label: "Talk to Customer Care team", icon: "/_assets/icons/js.svg", link: "/" %}
</div>
Binary file added _assets/fonts/JetBrainsMono[wght].ttf
Binary file not shown.
Binary file not shown.
93 changes: 93 additions & 0 deletions _assets/fonts/inter/OFL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
72 changes: 72 additions & 0 deletions _assets/fonts/inter/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Inter Variable Font
===================

This download contains Inter as both a variable font and static fonts.

Inter is a variable font with these axes:
slnt
wght

This means all the styles are contained in a single file:
Inter-VariableFont_slnt,wght.ttf

If your app fully supports variable fonts, you can now pick intermediate styles
that aren’t available as static fonts. Not all apps support variable fonts, and
in those cases you can use the static font files for Inter:
static/Inter-Thin.ttf
static/Inter-ExtraLight.ttf
static/Inter-Light.ttf
static/Inter-Regular.ttf
static/Inter-Medium.ttf
static/Inter-SemiBold.ttf
static/Inter-Bold.ttf
static/Inter-ExtraBold.ttf
static/Inter-Black.ttf

Get started
-----------

1. Install the font files you want to use

2. Use your app's font picker to view the font family and all the
available styles

Learn more about variable fonts
-------------------------------

https://developers.google.com/web/fundamentals/design-and-ux/typography/variable-fonts
https://variablefonts.typenetwork.com
https://medium.com/variable-fonts

In desktop apps

https://theblog.adobe.com/can-variable-fonts-illustrator-cc
https://helpx.adobe.com/nz/photoshop/using/fonts.html#variable_fonts

Online

https://developers.google.com/fonts/docs/getting_started
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide
https://developer.microsoft.com/en-us/microsoft-edge/testdrive/demos/variable-fonts

Installing fonts

MacOS: https://support.apple.com/en-us/HT201749
Linux: https://www.google.com/search?q=how+to+install+a+font+on+gnu%2Blinux
Windows: https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows

Android Apps

https://developers.google.com/fonts/docs/android
https://developer.android.com/guide/topics/ui/look-and-feel/downloadable-fonts

License
-------
Please read the full license text (OFL.txt) to understand the permissions,
restrictions and requirements for usage, redistribution, and modification.

You can use them in your products & projects – print or digital,
commercial or otherwise.

This isn't legal advice, please consider consulting a lawyer and see the full
license for all details.
Binary file added _assets/fonts/inter/static/Inter-Black.ttf
Binary file not shown.
Binary file added _assets/fonts/inter/static/Inter-Bold.ttf
Binary file not shown.
Binary file added _assets/fonts/inter/static/Inter-ExtraBold.ttf
Binary file not shown.
Binary file added _assets/fonts/inter/static/Inter-ExtraLight.ttf
Binary file not shown.
Binary file added _assets/fonts/inter/static/Inter-Light.ttf
Binary file not shown.
Binary file added _assets/fonts/inter/static/Inter-Medium.ttf
Binary file not shown.
Binary file added _assets/fonts/inter/static/Inter-Regular.ttf
Binary file not shown.
Binary file added _assets/fonts/inter/static/Inter-SemiBold.ttf
Binary file not shown.
Binary file added _assets/fonts/inter/static/Inter-Thin.ttf
Binary file not shown.
9 changes: 9 additions & 0 deletions _assets/icons/js.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1850d92

Please sign in to comment.