Skip to content

Commit 9cb8cd6

Browse files
committed
docs: remove Open Collective
- Rewrite the documentation's donate page - Remove donation infos from individual team members - Add all team members - Fix GitHub username regex in Sphinx extension - Rewrite the project README - Use HTML for centered text, add logo, update badges - Rephrase text sections - Remove Open Collective and update support section - Replace all links to Open Collective with a link to the latest docs
1 parent 96627e7 commit 9cb8cd6

File tree

13 files changed

+131
-122
lines changed

13 files changed

+131
-122
lines changed

.github/DISCUSSION_TEMPLATE/general.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ body:
4949
5050
----
5151
52-
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/donate.html)
52+
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/latest/donate.html)

.github/DISCUSSION_TEMPLATE/q-a.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ body:
4949
5050
----
5151
52-
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/donate.html)
52+
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/latest/donate.html)

.github/FUNDING.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
open_collective: streamlink
1+
custom:
2+
- "https://streamlink.github.io/latest/donate.html"

.github/ISSUE_TEMPLATE/1_plugin_issue.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ body:
7777
7878
----
7979
80-
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/donate.html)
80+
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/latest/donate.html)

.github/ISSUE_TEMPLATE/2_bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,4 @@ body:
8181
8282
----
8383
84-
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/donate.html)
84+
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/latest/donate.html)

.github/ISSUE_TEMPLATE/3_plugin_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ body:
6464
6565
----
6666
67-
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/donate.html)
67+
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/latest/donate.html)

.github/ISSUE_TEMPLATE/4_feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ body:
5050
5151
----
5252
53-
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/donate.html)
53+
[❤️ Love Streamlink? Please consider supporting the project maintainers. Thanks! ❤️](https://streamlink.github.io/latest/donate.html)

.github/release_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Please see the [CLI documentation](https://streamlink.github.io/cli.html) for ho
1313

1414
## ❤️ Support
1515

16-
If you think that Streamlink is useful and if you want to keep the project alive, then please consider supporting its maintainers by sending a small and optionally recurring tip via the [available options](https://streamlink.github.io/donate.html).
16+
If you think that Streamlink is useful and if you want to keep the project alive, then please consider supporting its maintainers by sending a small and optionally recurring tip via the [available options](https://streamlink.github.io/latest/donate.html).
1717
Your support is very much appreciated, thank you!
1818
{%- if contributors %}
1919

README.md

Lines changed: 42 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,84 @@
1-
# [Streamlink][streamlink-website]
1+
<h1 align="center"><a href="https://streamlink.github.io/">Streamlink<br><img height="150" alt="Streamlink" src="https://raw.githubusercontent.com/streamlink/streamlink/master/icon.svg"></a></h1>
22

3-
[![Github build status][workflow-status-badge]][workflow-status]
4-
[![codecov.io][codecov-coverage-badge]][codecov-coverage] [![Backers on Open Collective][opencollective-backers-badge]](#backers) [![Sponsors on Open Collective][opencollective-sponsors-badge]](#sponsors)
3+
<p align="center">
4+
<a href="https://streamlink.github.io/install.html"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/streamlink.svg?style=flat-square&maxAge=86400"></a>
5+
<a href="https://streamlink.github.io/changelog.html"><img alt="Latest release" src="https://img.shields.io/github/release/streamlink/streamlink.svg?style=flat-square&maxAge=86400"></a>
6+
<a href="https://github.com/streamlink/streamlink"><img alt="License" src="https://img.shields.io/github/license/streamlink/streamlink.svg?style=flat-square&maxAge=86400"></a>
7+
<a href="https://github.com/streamlink/streamlink/issues"><img alt="Open issues" src="https://img.shields.io/github/issues/streamlink/streamlink.svg?style=flat-square&maxAge=86400"></a>
8+
<a href="https://github.com/streamlink/streamlink/actions?query=event%3Apush"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/streamlink/streamlink/main.yml?branch=master&event=push&style=flat-square&maxAge=86400"></a>
9+
<a href="https://codecov.io/github/streamlink/streamlink?branch=master"><img alt="Overall code coverage" src="https://img.shields.io/codecov/c/github/streamlink/streamlink.svg?branch=master&style=flat-square&maxAge=86400"></a>
10+
</p>
511

6-
Streamlink is a CLI utility which pipes video streams from various services into a video player, such as VLC.
12+
<p align="center">
13+
A Python library and command-line interface which pipes streams from various services into a video player.<br>
14+
Avoid resource-heavy and unoptimized websites, and still enjoy streamed content.
15+
</p>
716

8-
The main purpose of streamlink is to avoid resource-heavy and unoptimized websites, while still allowing the user to enjoy various streamed content.
17+
<p align="center">
18+
Streamlink was forked in 2016 from the abandoned <em>Livestreamer</em> project.
19+
</p>
920

10-
Streamlink is a fork of the [Livestreamer][livestreamer] project.
1121

12-
Please note that by using this application you're bypassing ads run by
13-
sites such as Twitch.tv. Please consider donating or paying for subscription
14-
services when they are available for the content you consume and enjoy.
22+
# 📦 Installation
1523

16-
17-
# [Installation][streamlink-installation]
18-
19-
Please refer to our documentation for different ways to install Streamlink:
24+
Please take a look at the documentation for different ways of installing Streamlink:
2025

2126
- [Windows][streamlink-installation-windows]
2227
- [macOS][streamlink-installation-macos]
2328
- [Linux and BSD][streamlink-installation-linux-and-bsd]
2429
- [PyPI package and source code][streamlink-installation-pypi-source]
2530

26-
# Features
2731

28-
Streamlink is built upon a plugin system which allows support for new services to be easily added.
29-
Most of the big streaming services are supported, such as:
32+
# 👍 Features
33+
34+
Streamlink is built on top of a plugin system which allows support for new services to be added easily.
35+
36+
Most of the popular streaming services are supported, such as:
3037

3138
- [Twitch](https://www.twitch.tv)
3239
- [YouTube](https://www.youtube.com)
3340
- [Livestream](https://livestream.com)
3441
- [Dailymotion](https://www.dailymotion.com)
3542

36-
... and many more. A full list of plugins currently included can be found on the [plugin page][streamlink-plugins].
43+
... and many more. A list of all plugins currently included can be found on the [plugins page][streamlink-plugins].
3744

3845

39-
# Quickstart
46+
# 💡 Quickstart
4047

41-
After installing, simply use:
48+
After installing, simply run:
4249

50+
```sh
51+
streamlink "STREAMURL" best
4352
```
44-
streamlink STREAMURL best
45-
```
4653

47-
The default behavior of Streamlink is to play back streams in the VLC player.
54+
The default behavior of Streamlink is to play back streams in the [VLC player][player-vlc], but a lot of other options and output methods are available, such as writing the stream to the filesystem, reading stream metadata, etc.
55+
56+
For more in-depth usage, please refer to the [CLI documentation][streamlink-documentation-cli].
4857

49-
For more in-depth usage and install instructions, please refer to the [detailed documentation][streamlink-documentation].
58+
An [API guide][streamlink-documentation-apiguide] and [API reference][streamlink-documentation-apiref] is available for Python implementors of Streamlink.
5059

5160

52-
# Contributing
61+
# 🙏 Contributing
5362

5463
All contributions are welcome.
5564
Feel free to open a new thread on the issue tracker or submit a new pull request.
5665
Please read [CONTRIBUTING.md][contributing] first. Thanks!
5766

58-
[![Contributors][opencollective-contributors]][contributors]
59-
6067

61-
## Backers
68+
# ❤️ Support
6269

63-
Thank you to all our backers! \[[Become a backer][opencollective-backer]\]
70+
If you think that Streamlink is useful and if you want to keep the project alive, then please consider supporting its maintainers by sending a small and optionally recurring tip via the [available options][support].
71+
Your support is very much appreciated, thank you!
6472

65-
[![Backers on Open Collective][opencollective-backers-image]][opencollective-backers]
6673

67-
68-
## Sponsors
69-
70-
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. \[[Become a sponsor][opencollective-sponsor]\]
71-
72-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/0/avatar.svg)](https://opencollective.com/streamlink/sponsor/0/website)
73-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/1/avatar.svg)](https://opencollective.com/streamlink/sponsor/1/website)
74-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/2/avatar.svg)](https://opencollective.com/streamlink/sponsor/2/website)
75-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/3/avatar.svg)](https://opencollective.com/streamlink/sponsor/3/website)
76-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/4/avatar.svg)](https://opencollective.com/streamlink/sponsor/4/website)
77-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/5/avatar.svg)](https://opencollective.com/streamlink/sponsor/5/website)
78-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/6/avatar.svg)](https://opencollective.com/streamlink/sponsor/6/website)
79-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/7/avatar.svg)](https://opencollective.com/streamlink/sponsor/7/website)
80-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/8/avatar.svg)](https://opencollective.com/streamlink/sponsor/8/website)
81-
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/9/avatar.svg)](https://opencollective.com/streamlink/sponsor/9/website)
82-
83-
84-
[streamlink-website]: https://streamlink.github.io
85-
[streamlink-plugins]: https://streamlink.github.io/plugins.html
86-
[streamlink-documentation]: https://streamlink.github.io/cli.html
87-
[streamlink-installation]: https://streamlink.github.io/install.html
8874
[streamlink-installation-windows]: https://streamlink.github.io/install.html#windows
8975
[streamlink-installation-macos]: https://streamlink.github.io/install.html#macos
9076
[streamlink-installation-linux-and-bsd]: https://streamlink.github.io/install.html#linux-and-bsd
9177
[streamlink-installation-pypi-source]: https://streamlink.github.io/install.html#pypi-package-and-source-code
92-
[livestreamer]: https://github.com/chrippa/livestreamer
78+
[streamlink-documentation-cli]: https://streamlink.github.io/cli.html
79+
[streamlink-documentation-apiguide]: https://streamlink.github.io/api_guide.html
80+
[streamlink-documentation-apiref]: https://streamlink.github.io/api.html
81+
[streamlink-plugins]: https://streamlink.github.io/plugins.html
82+
[player-vlc]: https://www.videolan.org/vlc/
9383
[contributing]: https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md
94-
[changelog]: https://github.com/streamlink/streamlink/blob/master/CHANGELOG.rst
95-
[contributors]: https://github.com/streamlink/streamlink/graphs/contributors
96-
[workflow-status]: https://github.com/streamlink/streamlink/actions?query=event%3Apush
97-
[workflow-status-badge]: https://github.com/streamlink/streamlink/workflows/Test,%20build%20and%20deploy/badge.svg?branch=master&event=push
98-
[codecov-coverage]: https://codecov.io/github/streamlink/streamlink?branch=master
99-
[codecov-coverage-badge]: https://codecov.io/github/streamlink/streamlink/coverage.svg?branch=master
100-
[opencollective-contributors]: https://opencollective.com/streamlink/contributors.svg?width=890
101-
[opencollective-backer]: https://opencollective.com/streamlink#backer
102-
[opencollective-backers]: https://opencollective.com/streamlink#backers
103-
[opencollective-backers-image]: https://opencollective.com/streamlink/backers.svg?width=890
104-
[opencollective-sponsor]: https://opencollective.com/streamlink#sponsor
105-
[opencollective-backers-badge]: https://opencollective.com/streamlink/backers/badge.svg
106-
[opencollective-sponsors-badge]: https://opencollective.com/streamlink/sponsors/badge.svg
84+
[support]: https://streamlink.github.io/latest/donate.html

docs/_static/styles/custom.css

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -288,14 +288,16 @@ table.table-custom-layout.table-custom-layout-dependencies tbody td {
288288
Content
289289
*/
290290

291-
.github-avatar {
292-
float: left;
293-
width: 150px;
294-
height: 150px;
295-
margin: 0 1rem 1rem 0;
296-
}
297-
.github-avatar + .container > ul > li {
291+
.team-members {
292+
display: flex;
298293
list-style: none;
294+
justify-content: space-between;
295+
}
296+
.team-members a:after {
297+
display: none !important;
298+
}
299+
.team-members figcaption a.headerlink {
300+
display: none;
299301
}
300302

301303
section#plugins dl.field-list {

0 commit comments

Comments
 (0)