diff --git a/docs/figures.md b/docs/figures.md index f08b952..82ef152 100644 --- a/docs/figures.md +++ b/docs/figures.md @@ -7,12 +7,12 @@ thumbnail: ./thumbnails/todo.png MyST Markdown can be used to include images and figures in your notebooks as well as referencing those images easily in other cells of the notebook. ```{tip} -For a general description of the MyST figures and image directives see the [main MyST docs](https://myst-tools.org/docs/mystjs/figures) at https://myst-tools.org, read on for notebook specific consideratons +For a general description of the MyST figures and image directives see the [main MyST docs](https://mystmd.org/docs/mystjs/figures) at https://mystmd.org, read on for notebook specific considerations ``` ## Simple images -Adding an imge to your notebook using the standard Markdown syntax will work as usual with the standard markdown syntax: +Adding an image to your notebook using the standard Markdown syntax will work as usual with the standard markdown syntax: ```md ![alt](link 'title') @@ -42,15 +42,15 @@ The `figure` directive is similar to `image` but allows for a caption and sequen ## Cell attachments -Notebooks allow images to be added as cell attachments. This is typically acheived via drag and drop in the ntoebook interface and results in the image being added to the notebook itself as a base64 encoded string. +Notebooks allow images to be added as cell attachments. This is typically achieved via drag and drop in the notebook interface and results in the image being added to the notebook itself as a base64 encoded string. -Cell attachements are inserted into the notebook using standard markdown syntax such as: +Cell attachments are inserted into the notebook using standard markdown syntax such as: ```{md} ![image.png](attachment:7c0e625d-6238-464f-8100-8d008f30848b.png) ``` -These links are inserted automatically by jupyter when an attachement is added. Once the link syntax is known these can be changed to `image` or `figure` directives where captions can be added attributes can be used to, for example control the image size +These links are inserted automatically by jupyter when an attachment is added. Once the link syntax is known these can be changed to `image` or `figure` directives where captions can be added attributes can be used to, for example control the image size ````{myst} ```{image} attachment:7c0e625d-6238-464f-8100-8d008f30848b.png diff --git a/docs/index.md b/docs/index.md index 21a0e22..24b5fe5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,15 +1,15 @@ --- title: MyST extension for JupyterLab -description: The MyST (Markedly Structured Text) JupyterLab extension switches the default markdown rendering in JuptyerLab to `mystjs`. Allowing notebook authors to create richer content using MyST rols and directives alongide plain markdown to create notebook based content from technical tutorials though to publication-quality documents with bibliography support. +description: The MyST Markdown JupyterLab extension switches the default markdown rendering in JupyterLab to MyST. Allowing notebook authors to create richer content using MyST roles and directives alongside plain markdown to create notebook based content from technical tutorials though to publication-quality documents with bibliography support. --- -Render markdown cells using [MyST Markdown](https://myst-tools.org/), including support for rich frontmatter, interactive references, admonitions, figure numbering, tabs, cards, and grids! +Render markdown cells using [MyST Markdown](https://mystmd.org/), including support for rich frontmatter, interactive references, admonitions, figure numbering, tabs, cards, and grids! ![](../images/walkthrough.gif) ## Requirements -- JupyterLab >= 3.0 +- JupyterLab >= 4.0 ## Install @@ -21,7 +21,7 @@ pip install jupyterlab_myst ## Features -`jupyterlab-myst` is a fully featured markdown renderer for technical documents, [get started with MyST Markdown](https://myst-tools.org/docs/mystjs/quickstart-myst-markdown). It supports the MyST `{eval}` inline role, which facilitates the interweaving of code outputs and prose. For example, we can use inline expressions to explore the properties of a NumPy array. +`jupyterlab-myst` is a fully featured markdown renderer for technical documents, [get started with MyST Markdown](https://mystmd.org/docs/mystjs/quickstart-myst-markdown). It supports the MyST `{eval}` inline role, which facilitates the interweaving of code outputs and prose. For example, we can use inline expressions to explore the properties of a NumPy array. In the code cell: diff --git a/docs/myst.yml b/docs/myst.yml index 2218f48..a2eccb8 100644 --- a/docs/myst.yml +++ b/docs/myst.yml @@ -1,22 +1,31 @@ -# See docs at: https://myst-tools.org/docs/mystjs/frontmatter +# See docs at: https://mystmd.org/docs/mystjs/frontmatter version: 1 project: title: jupyterlab-myst - description: Write MyST in Juptyerlab notebooks. This extension replaces the default markdown rendering enabling the rich features of MyST to be used in Mardkown cells. + description: Write MyST in JupyterLab Notebooks. This extension replaces the default markdown rendering enabling the rich features of MyST to be used in Markdown cells. keywords: [] authors: [] github: https://github.com/executablebooks/jupyterlab-myst - # bibliography: [] + references: + python: https://docs.python.org/3.7/ + jupyterbook: https://jupyterbook.org/en/stable/ + guide: https://mystmd.org/guide/ + spec: https://mystmd.org/spec/ + abbreviations: + AST: Abstract Syntax Tree + DOI: Digital Object Identifier + MyST: Markedly Structured Text + CLI: Command Line Interface + HTML: Hypertext Markup Language + PDF: Portable Document Format + YAML: Yet Another Markup Language + REES: Reproducible Execution Environment Specification + RST: reStructuredText site: template: book-theme - # title: - # logo: - projects: - - slug: jupyterlab - path: . nav: [] actions: - title: Learn More - url: https://myst-tools.org/docs/jupyterlab + url: https://mystmd.org/jupyterlab domains: - - jupyterlab.myst.tools + - mystmd-jupyterlab.curve.space