Skip to content

Commit 3f228a8

Browse files
committed
Convert rST README to Markdown with pandoc
1 parent b7bc586 commit 3f228a8

File tree

1 file changed

+44
-64
lines changed

1 file changed

+44
-64
lines changed

README.md

Lines changed: 44 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,110 +1,90 @@
1-
`BinderHub`_
2-
============
1+
[BinderHub](https://github.com/jupyterhub/binderhub)
2+
====================================================
33

4-
.. image:: https://img.shields.io/travis/com/jupyterhub/binderhub/master?logo=travis
5-
:target: https://travis-ci.com/jupyterhub/binderhub
6-
:alt: travis status
4+
[![travis status](https://img.shields.io/travis/com/jupyterhub/binderhub/master?logo=travis)](https://travis-ci.com/jupyterhub/binderhub)
75

8-
.. image:: https://img.shields.io/readthedocs/binderhub?logo=read-the-docs
9-
:target: https://binderhub.readthedocs.io/en/latest/
10-
:alt: Documentation Status
6+
[![Documentation Status](https://img.shields.io/readthedocs/binderhub?logo=read-the-docs)](https://binderhub.readthedocs.io/en/latest/)
117

12-
.. image:: https://img.shields.io/badge/dynamic/json.svg?label=latest&url=https://jupyterhub.github.io/helm-chart/info.json&query=$.binderhub.latest&colorB=orange
13-
:target: https://jupyterhub.github.io/helm-chart/
14-
:alt: Latest chart development release
8+
[![Latest chart development release](https://img.shields.io/badge/dynamic/json.svg?label=latest&url=https://jupyterhub.github.io/helm-chart/info.json&query=$.binderhub.latest&colorB=orange)](https://jupyterhub.github.io/helm-chart/)
159

16-
.. image:: https://img.shields.io/badge/issue_tracking-github-blue.svg
17-
:target: https://github.com/jupyterhub/binderhub/issues
18-
:alt: GitHub
10+
[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/jupyterhub/binderhub/issues)
1911

20-
.. image:: https://img.shields.io/badge/help_forum-discourse-blue.svg
21-
:target: https://discourse.jupyter.org/c/binder/binderhub
22-
:alt: Discourse
12+
[![Discourse](https://img.shields.io/badge/help_forum-discourse-blue.svg)](https://discourse.jupyter.org/c/binder/binderhub)
2313

24-
.. image:: https://img.shields.io/badge/social_chat-gitter-blue.svg
25-
:target: https://gitter.im/jupyterhub/binder
26-
:alt: Gitter
14+
[![Gitter](https://img.shields.io/badge/social_chat-gitter-blue.svg)](https://gitter.im/jupyterhub/binder)
2715

28-
.. image:: https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter
29-
:target: https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md
30-
:alt: Contribute
16+
[![Contribute](https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter)](https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md)
3117

3218
What is BinderHub?
3319
------------------
3420

35-
**BinderHub** allows you to ``BUILD`` and ``REGISTER`` a Docker image from a
36-
Git repository, then ``CONNECT`` with JupyterHub, allowing you to create a
37-
public IP address that allows users to interact with the code and environment
38-
within a live JupyterHub instance. You can select a specific branch name,
39-
commit, or tag to serve.
21+
**BinderHub** allows you to `BUILD` and `REGISTER` a Docker image from a
22+
Git repository, then `CONNECT` with JupyterHub, allowing you to create a
23+
public IP address that allows users to interact with the code and
24+
environment within a live JupyterHub instance. You can select a specific
25+
branch name, commit, or tag to serve.
4026

4127
BinderHub ties together:
4228

43-
- `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ to provide
44-
a scalable system for authenticating users and spawning single user
45-
Jupyter Notebook servers, and
46-
47-
- `Repo2Docker <https://github.com/jupyter/repo2docker>`_ which generates
48-
a Docker image using a Git repository hosted online.
49-
50-
BinderHub is built with Python, kubernetes, tornado, npm, webpack, and sphinx.
29+
- [JupyterHub](https://github.com/jupyterhub/jupyterhub) to provide a
30+
scalable system for authenticating users and spawning single user
31+
Jupyter Notebook servers, and
32+
- [Repo2Docker](https://github.com/jupyter/repo2docker) which
33+
generates a Docker image using a Git repository hosted online.
5134

35+
BinderHub is built with Python, kubernetes, tornado, npm, webpack, and
36+
sphinx.
5237

5338
Documentation
5439
-------------
5540

56-
For more information about the architecture, use, and setup of BinderHub, see
57-
`the BinderHub documentation <https://binderhub.readthedocs.io>`_.
58-
41+
For more information about the architecture, use, and setup of
42+
BinderHub, see [the BinderHub
43+
documentation](https://binderhub.readthedocs.io).
5944

6045
Contributing
6146
------------
6247

6348
To contribute to the BinderHub project you can work on:
6449

65-
* `answering questions others have <https://discourse.jupyter.org/>`_,
66-
* writing documentation,
67-
* designing the user interface, or
68-
* writing code.
69-
70-
To see how to build the documentation, edit the user interface or modify the
71-
code see `the contribution guide <https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md>`_.
50+
- [answering questions others have](https://discourse.jupyter.org/),
51+
- writing documentation,
52+
- designing the user interface, or
53+
- writing code.
7254

55+
To see how to build the documentation, edit the user interface or modify
56+
the code see [the contribution
57+
guide](https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md).
7358

7459
Installation
7560
------------
7661

77-
**BinderHub** is based on Python 3, it's currently only hosted on GitHub
78-
(pip release soon). However, it can be installed using ``pip``::
62+
**BinderHub** is based on Python 3, it\'s currently only hosted on
63+
GitHub (pip release soon). However, it can be installed using `pip`:
7964

8065
pip install git+https://github.com/jupyterhub/binderhub
8166

82-
See `the BinderHub documentation <https://binderhub.readthedocs.io>`_ for
67+
See [the BinderHub documentation](https://binderhub.readthedocs.io) for
8368
a detailed guide on setting up your own BinderHub server.
8469

85-
8670
Why BinderHub?
8771
--------------
8872

89-
Collections of Jupyter notebooks are becoming more common in scientific research
90-
and data science. The ability to serve these collections on demand enhances the
91-
usefulness of these notebooks.
92-
73+
Collections of Jupyter notebooks are becoming more common in scientific
74+
research and data science. The ability to serve these collections on
75+
demand enhances the usefulness of these notebooks.
9376

9477
Who is BinderHub for?
9578
---------------------
96-
* **Users** who want to easily interact with computational environments that
97-
others have created.
98-
* **Authors** who want to create links that allow users to immediately interact with a
99-
computational enviroment that you specify.
100-
* **Deployers** who want to create their own BinderHub to run on whatever
101-
hardware they choose.
10279

80+
- **Users** who want to easily interact with computational
81+
environments that others have created.
82+
- **Authors** who want to create links that allow users to immediately
83+
interact with a computational enviroment that you specify.
84+
- **Deployers** who want to create their own BinderHub to run on
85+
whatever hardware they choose.
10386

10487
License
10588
-------
10689

107-
See ``LICENSE`` file in this repository.
108-
109-
110-
.. _BinderHub: https://github.com/jupyterhub/binderhub
90+
See `LICENSE` file in this repository.

0 commit comments

Comments
 (0)