Skip to content

Commit

Permalink
undo markdown changes
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 committed Sep 11, 2023
1 parent 485be7a commit 6ea21e1
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 29 deletions.
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
______________________________________________________________________

## name: "\\U0001F41B Bug report" about: Create a report to help us repair something that is currently broken labels: bug, status:Needs Triage
---
name: "\U0001F41B Bug report"
about: Create a report to help us repair something that is currently broken
labels: bug, status:Needs Triage
---

<!-- Welcome! Thank you for contributing. These HTML comments will not render in the issue, but you can delete them once you've read them if you prefer! -->

Expand Down Expand Up @@ -33,9 +35,9 @@ Here, we're looking for specific bugs in the Jupyter Notebook codebase. If you t
<!--Describe step-by-step instructions to reproduce the behavior-->

1. Go to '...'
1. Click on '...'
1. Scroll down to '...'
1. See error '...'
2. Click on '...'
3. Scroll down to '...'
4. See error '...'

<!--Describe how you diagnosed the issue. See the guidelines at
https://jupyter-notebook.readthedocs.io/en/latest/troubleshooting.html -->
Expand All @@ -50,9 +52,7 @@ https://jupyter-notebook.readthedocs.io/en/latest/troubleshooting.html -->

- Operating System and version: <!-- e.g. Linux Ubuntu 21.04 -->
- Browser and version: <!-- e.g. Chrome 92 -->

<!-- Please note the Notebook version you are working with. You can find this in the Help -> About Jupyter Notebook menu option or by running `jupyter --version` from your terminal -->

- Jupyter Notebook version: <!-- e.g. 3.1.7 -->

<!--The more content you provide, the more we can help!-->
Expand Down
8 changes: 5 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
______________________________________________________________________

## name: "\\U0001F680 Feature Request" about: Suggest a new feature or a change labels: enhancement, status:Needs Triage
---
name: "\U0001F680 Feature Request"
about: Suggest a new feature or a change
labels: enhancement, status:Needs Triage
---

<!-- Welcome! These HTML comments will not render in the issue, but you can delete them once you've read them if you prefer! -->

Expand Down
4 changes: 2 additions & 2 deletions docs/source/migrate_to_notebook7.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ migrating/custom-themes.md
migrating/multiple-interfaces.md
```

[find replacements for those that are not available]: https://jupyter-notebook.readthedocs.io/en/latest/migrating/frontend-extensions.html#jupyterlab-equivalent-extensions-to-the-classic-notebook
[jep 79]: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html
[nbclassic]: https://github.com/jupyter/nbclassic
[team-compass note]: https://github.com/jupyter/notebook-team-compass/issues/5#issuecomment-1085254000
[find replacements for those that are not available]: https://jupyter-notebook.readthedocs.io/en/latest/migrating/frontend-extensions.html#jupyterlab-equivalent-extensions-to-the-classic-notebook
[nbclassic]: https://github.com/jupyter/nbclassic
9 changes: 5 additions & 4 deletions docs/source/migrating/frontend-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,14 @@ You can check the following resources to see if your extension is available for

To get an idea of the extensions available for Notebook 7, you can check the following resources:

- [List of JupyterLab extensions]
- [Awesome Jupyter]
- [List of JupyterLab extensions][list of jupyterlab extensions]
- [Awesome Jupyter][awesome jupyter]

These resources are for JupyterLab, but many of them are compatible with Notebook 7 since Notebook 7 is based on JupyterLab.

[list of jupyterlab extensions]: https://jupyterlab-contrib.github.io/extensions.html
[awesome jupyter]: https://github.com/markusschanta/awesome-jupyter#jupyterlab-extensions

## JupyterLab equivalent extensions to the Classic Notebook

The `jupyterlab-contrib` organization maintains a list of extensions to ease the transition from the Classic Notebook to Notebook 7 and / or JupyterLab.
Expand All @@ -27,6 +30,4 @@ The list is available at the following URL: [Migrating from the Classic Notebook

![a screenshot showing extensions in classic and lab](https://user-images.githubusercontent.com/591645/229616855-94d34762-6666-4edd-a969-e85b285d7094.png)

[awesome jupyter]: https://github.com/markusschanta/awesome-jupyter#jupyterlab-extensions
[list of jupyterlab extensions]: https://jupyterlab-contrib.github.io/extensions.html
[migrate from classic]: https://jupyterlab-contrib.github.io/migrate_from_classical.html
4 changes: 2 additions & 2 deletions docs/source/migrating/multiple-interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ You can try JupyterLab, Notebook 7 and NBClassic installed together using [this

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gist/jtpio/35a72862c8be13dee31b61ebac2d9786/master?urlpath=/tree)

[lab-nb-nbclassic]: https://gist.github.com/jtpio/35a72862c8be13dee31b61ebac2d9786

## Using the `Interface` dropdown

Notebook 7 provides a dropdown menu to switch between the different user interfaces available on the same server.
Expand Down Expand Up @@ -84,5 +86,3 @@ way to view the NbClassic frontend. You would be able to manually
enable the extension when running an instance of Jupyter Server,
`> jupyter server --ServerApp.jpserver_extensions="nbclassic=True"`,
which will provide the NbClassic frontend at `/tree` path when visited.

[lab-nb-nbclassic]: https://gist.github.com/jtpio/35a72862c8be13dee31b61ebac2d9786
12 changes: 6 additions & 6 deletions docs/source/notebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ notebook and its dependencies.
computations attached to the code which generated them.
- Displaying the result of computation using rich media representations, such
as HTML, LaTeX, PNG, SVG, etc. For example, publication-quality figures
rendered by the \[matplotlib\] library, can be included inline.
- In-browser editing for rich text using the \[Markdown\] markup language, which
rendered by the [matplotlib] library, can be included inline.
- In-browser editing for rich text using the [Markdown] markup language, which
can provide commentary for the code, is not limited to plain text.
- The ability to easily include mathematical notation within markdown cells
using LaTeX, and rendered natively by [MathJax].
Expand All @@ -56,14 +56,14 @@ colleagues.

Notebooks may be exported to a range of static formats, including HTML (for
example, for blog posts), reStructuredText, LaTeX, PDF, and slide shows, via
the \[nbconvert\] command.
the [nbconvert] command.

Furthermore, any `.ipynb` notebook document available from a public
URL can be shared via the Jupyter Notebook Viewer \<nbviewer>.
This service loads the notebook document from the URL and renders it as a
static web page. The results may thus be shared with a colleague, or as a
public blog post, without other users needing to install the Jupyter notebook
themselves. In effect, nbviewer is simply \[nbconvert\] as
themselves. In effect, nbviewer is simply [nbconvert] as
a web service, so you can do your own static conversions with nbconvert,
without relying on nbviewer.

Expand Down Expand Up @@ -278,7 +278,7 @@ the IPython session.

_Raw_ cells provide a place in which you can write _output_ directly.
Raw cells are not evaluated by the notebook.
When passed through \[nbconvert\], raw cells arrive in the
When passed through [nbconvert], raw cells arrive in the
destination format unmodified. For example, you can type full LaTeX
into a raw cell, which will only be rendered by LaTeX after conversion by
nbconvert.
Expand Down Expand Up @@ -349,7 +349,7 @@ document content to the browser at the expense of performance.

One major feature of the Jupyter notebook is the ability to display plots that
are the output of running code cells. The IPython kernel is designed to work
seamlessly with the \[matplotlib\] plotting library to provide this functionality.
seamlessly with the [matplotlib] plotting library to provide this functionality.
Specific plotting library integration is a feature of the kernel.

## Installing kernels
Expand Down
8 changes: 4 additions & 4 deletions docs/source/notebook_7_features.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# New features in Notebook 7

This document describes the new features in Notebook 7 as originally mentioned in the related Jupyter Enhancement Proposal [JEP 79].
This document describes the new features in Notebook 7 as originally mentioned in the related Jupyter Enhancement Proposal [JEP 79][jep 79].

```{contents} Table of Contents
:depth: 3
Expand Down Expand Up @@ -124,10 +124,12 @@ pip install jupyterlab-rise

## A document-centric user experience

Despite all the new features and as stated in [JEP 79], Notebook 7 keeps the document-centric user experience of the Classic Notebook:
Despite all the new features and as stated in [JEP 79][jep 79], Notebook 7 keeps the document-centric user experience of the Classic Notebook:

> The Jupyter Notebook application offers a document-centric user experience. That is, in the Notebook application, the landing page that contains a file manager, running tools tab, and a few optional extras, is a launching point into opening standalone, individual documents. This document-centric experience is important for many users, and that is the first key point this proposal aims to preserve. Notebook v7 will be based on a different JavaScript implementation than v6, but it will preserve the document-centric experience, where each individual notebook opens in a separate browser tab and the visible tools and menus are focused on the open document.
[jep 79]: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html

## Compact View on Mobile Devices

Notebook 7 automatically switches to a more compact layout on mobile devices, making it convenient to run code on the go.
Expand All @@ -140,5 +142,3 @@ This was just a quick overview of the new features in Notebook 7. For more detai

- The [JupyterLab Documentation](https://jupyterlab.readthedocs.io/en/latest/) is a great resource to learn more about JupyterLab and the extensions available. Since Notebook 7 is based on JupyterLab, many of the features and extensions available for JupyterLab are also available for Notebook 7.
- [Migration Guide](./migrate_to_notebook7.md) for Notebook 7, which explains how to migrate from the Classic Notebook to Notebook 7.

[jep 79]: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html

0 comments on commit 6ea21e1

Please sign in to comment.