Welcome to Ved's Cheat-Sheet

Ved’s Cheat-Sheet¶

Welcome to Ved’s Cheat-Sheet — a living, growing personal knowledge base built with Jupyter Book and MyST Markdown. This book serves as a quick-reference guide, covering everything from programming syntax to development workflows.

• Ved's Cheat-Sheet
• Programming Languages
  • Python
  • JavaScript
• DevOps
  • Docker
  • GitHub
• Frameworks
  • JupyterBook
  • uv
• Cloud-Services
  • Amazon Web Services (AWS)
• Terminal
  • Bash
  • nano
  • Vim

About This Project¶

This project is authored by Vishal Lavangare (alias ^Vedclove) and is publicly hosted at github.com/Vedclove/Cheat-Sheet.

The book is built using:

• Jupyter Book — for beautiful, publication-quality books from Markdown and Notebooks

• MyST Markdown — a powerful Markdown flavor supporting roles and directives

• GitHub Actions — for automated CI/CD builds and deployments

• Sphinx — the underlying Python documentation engine

What’s Inside¶

Chapters at a Glance¶

How to Navigate¶

Step-by-step navigation guide:

1. Browse chapters using the Table of Contents in the left sidebar

2. Use the Previous / Next buttons at the bottom of each page

3. Click the ↑ / ↓ arrow icons to navigate sections

4. Use the download buttons in the top bar to export any page as .pdf or .ipynb

5. Click “Open in Colab” or “Launch Binder” on notebook pages for interactive execution

MyST Formatting Showcase¶

This section is the core reference for MyST syntax. Each subsection demonstrates a specific feature — bookmark it for future use.

Admonitions (Callout Boxes)¶

Admonitions are styled callout boxes. Here are all the built-in types:

Custom admonitions use {admonition} with a title and optional class:

Code Blocks¶

Fenced code block with syntax highlighting:

# A simple Python example
def greet(name: str) -> str:
    return f"Hello, {name}!"

print(greet("World"))

{code-block} directive — supports line numbers, captions, and line emphasis:

1
2
3
pip install jupyter-book      # install the tool
cd /path/to/repo              # navigate to your project
jb build mybook/              # <- this builds the HTML book

Bash example:

# Build the book
jb build mybook/

# Clean the build cache
jb clean mybook/

# Create a new book scaffold
jb create my-new-book/

Inline code uses backticks: python --version, git status, pip install.

Math & Equations¶

Inline math uses single dollar signs: $f(x) = ax^2 + bx + c$

Block math (unnumbered) uses double dollar signs:

Named, referenceable equations use the {math} directive:

Cross-reference it with: Equation (2) is Euler’s Identity — often called the most beautiful equation in mathematics.

Another named equation:

The Gaussian integral (3) appears frequently in probability and statistics.

Tables¶

Standard Markdown table:

{list-table} directive — great for wide tables or programmatic content:

Figures¶

Cross-reference figures like this: see Figure 1 for the Jupyter Book logo.

Dropdowns¶

Cross-References & Labels¶

You can label any heading or block with (label)= placed above it, then reference it using {ref}:

• Admonitions (Callout Boxes) — jumps to the Admonitions section

• Code Blocks — jumps to Code Blocks

• Math & Equations — jumps to Math & Equations

• Tables — jumps to Tables

• Cross-References & Labels — jumps to this very section

Definition Lists¶

Jupyter Book

A tool for building beautiful, publication-quality books from Markdown and Jupyter Notebooks.

MyST Markdown

MyST — a rich Markdown dialect supporting Sphinx roles and directives.

Sphinx

The Python-based documentation engine that powers Jupyter Book under the hood.

Directive

A multi-line content block that acts like a function, e.g., ```{note} ... ```.

Role

An inline markup element that acts like a function, e.g., {kbd}`Ctrl`.

Footnotes¶

This sentence references a footnote.^[1]

Footnotes can contain any Markdown — links, bold, code, etc.^[2]

Line Blocks¶

Line blocks preserve newlines and indentation — useful for addresses, poetry, or structured prose:

| Vishal Lavangare | GitHub: github.com/Vedclove | Project: Cheat-Sheet | Branch: main

Margin Notes¶

Margin content is placed using the {margin} directive. It renders alongside the main text in the page margin.

Epigraph & Pull-Quote¶

Sidebar¶

The {sidebar} directive floats content to the side, letting it coexist with surrounding body text. It’s great for short bios, glossary terms, or quick links.

Rubric (Un-numbered Heading)¶

A {rubric} creates a styled, un-numbered heading — useful for visual separation without affecting the TOC hierarchy.

Comments¶

Comments in MyST use a % prefix. They are stripped from output entirely.

Syntax:

% This is a comment
% It won't appear in the rendered output

Quick Reference Card¶

This is your at-a-glance cheat sheet for the cheat sheet:

Contributing¶

Spotted a mistake or want to add a new topic?

1. Fork the repo at github.com/Vedclove/Cheat-Sheet

2. Create a new branch: git checkout -b add/my-topic

3. Add or edit .md / .ipynb files in the mybook/ directory

4. Update _toc.yml to include your new page

5. Submit a Pull Request

Built with Jupyter Book · Authored by Vedclove · Source on GitHub