[{"data":1,"prerenderedAt":46},["Reactive",2],{"blog-post-jupyter-markdown-quickstart-guide":3},{"slug":4,"title":5,"description":6,"excerpt":7,"date":8,"category":9,"author":10,"keywords":11,"readingMinutes":12,"html":13,"headings":14,"tools":30,"related":31},"jupyter-markdown-quickstart-guide","Jupyter Markdown Guide: Quickstart for Software Engineers","Learn the basics of Jupyter Markdown in our quickstart guide. Ideal for software engineers to enhance project documentation.","Welcome to the Jupyter Markdown Quickstart Guide. This tutorial is created for software engineers who are interested in utilizing Markdown within their Jupyter notebooks. We will explore the…","2024-07-07","Tutorial","Matthew Rathbone","Jupyter Markdown quickstart guide",2,"\u003Ch2 id=\"introduction\">Introduction\u003C/h2>\n\u003Cp>Welcome to the \u003Cstrong>Jupyter Markdown Quickstart Guide\u003C/strong>. This tutorial is created for software engineers who are interested in utilizing Markdown within their Jupyter notebooks. We will explore the basics of Markdown in Jupyter, providing numerous code examples that you can use and modify for your projects.\u003C/p>\n\u003Ch2 id=\"what-is-jupyter-markdown\">What is Jupyter Markdown\u003C/h2>\n\u003Cp>Jupyter uses cells to structure content, which can be done in two primary formats - Code and Markdown. While Code cells contain the actual scripts, Markdown cells contain text, images, links, and equations. The Markdown language allows us to style our text in a format that's easier to read and write.\u003C/p>\n\u003Ch2 id=\"getting-started-with-jupyter-markdown\">Getting started with Jupyter Markdown\u003C/h2>\n\u003Cp>Before we dive into writing in Markdown, ensure you have \u003Ca href=\"https://jupyter.org/install.html\">Jupyter\u003C/a> installed in your local environment. If not, you can install with pip:\u003C/p>\n\u003Cpre>\u003Ccode class=\"hljs language-python\">pip install jupyter\n\u003C/code>\u003C/pre>\u003Cp>To start a Jupyter notebook, run:\u003C/p>\n\u003Cpre>\u003Ccode class=\"hljs language-python\">jupyter notebook\n\u003C/code>\u003C/pre>\u003Cp>Your default web browser will open with the Jupyter Notebook homepage. Here, you can create a new Jupyter notebook by clicking on 'New' > 'Python 3'.\u003C/p>\n\u003Cp>\u003Cimg src=\"Jupyter-Create-Notebook.png\" alt=\"creating-jupyter-notebook\">\u003C/p>\n\u003Cp>A new notebook will open. In the first cell, you can select the dropdown at the top of the notebook that says 'Code', and change it to 'Markdown':\u003C/p>\n\u003Cp>\u003Cimg src=\"Jupyter-Select-Markdown.png\" alt=\"markdown-type\">\u003C/p>\n\u003Cp>You're now ready to write in Markdown!\u003C/p>\n\u003Ch2 id=\"basic-jupyter-markdown-syntax\">Basic Jupyter Markdown Syntax\u003C/h2>\n\u003Ch3 id=\"headers\">Headers:\u003C/h3>\n\u003Cp>We can create a header in Jupyter markdown using the '#' symbol. The number of '#' symbols determines the header level, for example:\u003C/p>\n\u003Cpre>\u003Ccode class=\"hljs language-markdown\">\u003Cspan class=\"hljs-section\"># H1\u003C/span>\n\u003Cspan class=\"hljs-section\">## H2\u003C/span>\n\u003Cspan class=\"hljs-section\">### H3\u003C/span>\n\u003Cspan class=\"hljs-section\">#### H4\u003C/span>\n\u003C/code>\u003C/pre>\u003Ch3 id=\"bold-and-italic\">Bold and Italic:\u003C/h3>\n\u003Cp>If we want to make a text bold, we wrap it within two asterisks or two underscores. To make a text italic, we wrap it within a single asterisk or a single underscore.\u003C/p>\n\u003Cpre>\u003Ccode class=\"hljs language-markdown\">\u003Cspan class=\"hljs-strong\">**Bold Text**\u003C/span>\n\u003Cspan class=\"hljs-strong\">__Bold Text__\u003C/span>\n\u003Cspan class=\"hljs-emphasis\">*Italic Text*\u003C/span>\n\u003Cspan class=\"hljs-emphasis\">_Italic Text_\u003C/span>\n\u003C/code>\u003C/pre>\u003Cp>For more detailed and extensive markdown styling like coloring text, visit this \u003Ca href=\"/blog/how-to-change-text-color-in-markdown\">previous post\u003C/a>.\u003C/p>\n\u003Ch3 id=\"lists\">Lists:\u003C/h3>\n\u003Cp>Making lists in Markdown is straightforward. You can create an unordered list using '*' or '-' or '+', and an ordered list using numbers:\u003C/p>\n\u003Cpre>\u003Ccode class=\"hljs language-markdown\">\u003Cspan class=\"hljs-bullet\">-\u003C/span> List item 1\n\u003Cspan class=\"hljs-bullet\">-\u003C/span> List item 2\n\u003Cspan class=\"hljs-bullet\">-\u003C/span> List item 3\n\n\u003Cspan class=\"hljs-bullet\">1.\u003C/span> List item 1\n\u003Cspan class=\"hljs-bullet\">2.\u003C/span> List item 2\n\u003Cspan class=\"hljs-bullet\">3.\u003C/span> List item 3\n\u003C/code>\u003C/pre>\u003Cp>Check our extensive guide on \u003Ca href=\"/blog/using-nested-lists-and-sub-bullets-in-markdown\">nested lists and sub bullets in markdown\u003C/a>.\u003C/p>\n\u003Ch3 id=\"code\">Code:\u003C/h3>\n\u003Cp>Enclose your code between two backticks for inline code. For a code block, enclose your code between three backticks:\u003C/p>\n\u003Cpre>\u003Ccode class=\"hljs language-markdown\">Inline code: \u003Cspan class=\"hljs-code\">`print('Hello, world!')`\u003C/span>\n\nCode block:\n\u003C/code>\u003C/pre>\u003Cp>def func():\u003Cbr>    print('Hello, world!')\u003Cbr>func()\u003C/p>\n\u003Cpre>\u003Ccode>\n\u003C/code>\u003C/pre>\u003Ch3 id=\"links\">Links:\u003C/h3>\n\u003Cp>Create a link with the format \u003Ccode>[Link Text](URL)\u003C/code>:\u003C/p>\n\u003Cpre>\u003Ccode class=\"hljs language-markdown\">Visit our site: [\u003Cspan class=\"hljs-string\">here\u003C/span>](\u003Cspan class=\"hljs-link\">https://blog.markdowntools.com/\u003C/span>)\n\u003C/code>\u003C/pre>\u003Ch3 id=\"images\">Images:\u003C/h3>\n\u003Cp>Insert an image using the format \u003Ccode>![Alt Text](URL)\u003C/code>. \u003C/p>\n\u003Cpre>\u003Ccode class=\"hljs language-markdown\">![\u003Cspan class=\"hljs-string\">My Image\u003C/span>](\u003Cspan class=\"hljs-link\">image.png\u003C/span>)\n\u003C/code>\u003C/pre>\u003Cp>For advanced markdown features such as tables, quotes, horizontal rules, and more, refer to this \u003Ca href=\"/blog/markdown-table-ultimate-guide\">comprehensive guide on markdown syntax\u003C/a>.\u003C/p>\n\u003Ch2 id=\"utilizing-jupyter-markdown-for-better-documentation\">Utilizing Jupyter Markdown for Better Documentation\u003C/h2>\n\u003Cp>By combining text and scripts in one document, Jupyter Markdown can help you create a detailed documentation for your software project, enabling you to explain what your code does in a clear and engaging way. After all, code that's better documented is easier to understand, maintain, and reuse. \u003C/p>\n\u003Cp>In conclusion, understanding Markdown and effectively using it can significantly contribute to collaborative and reproducible data science. Happy coding!\u003C/p>\n",[15,18,21,24,27],{"id":16,"text":17,"level":12},"introduction","Introduction",{"id":19,"text":20,"level":12},"what-is-jupyter-markdown","What is Jupyter Markdown",{"id":22,"text":23,"level":12},"getting-started-with-jupyter-markdown","Getting started with Jupyter Markdown",{"id":25,"text":26,"level":12},"basic-jupyter-markdown-syntax","Basic Jupyter Markdown Syntax",{"id":28,"text":29,"level":12},"utilizing-jupyter-markdown-for-better-documentation","Utilizing Jupyter Markdown for Better Documentation",[],[32,39],{"slug":33,"title":34,"description":35,"excerpt":36,"date":37,"category":9,"author":10,"keywords":38,"readingMinutes":12},"python-markdown-example","Python Markdown Tutorial & Examples for Software Engineers","Learn how to use Python Markdown for converting text to HTML. Our tutorial provides practical examples for software engineers.","Welcome to a detailed tutorial that's poised to enhance your working knowledge with Python Markdown. The post provides deep insights, practical examples and in-depth explanations of the Python…","2024-05-06","Python markdown example",{"slug":40,"title":41,"description":42,"excerpt":43,"date":44,"category":9,"author":10,"keywords":45,"readingMinutes":12},"reddit-markdown-mode-quickstart-guide","Reddit Markdown Mode Quickstart Guide and Tips","Learn how to enable and use Reddit Markdown for text formatting?bold, italics, lists, hyperlinks, blockquotes, and more?in this easy guide.","Markdown is a lightweight and straightforward markup language that you can use for formatting text. It's popular among developers primarily due to its ease of use and simplicity. Notably, Reddit…","2024-07-08","Reddit markdown mode quickstart guide",1792184940483]