Skip to content

Latest commit

 

History

History
172 lines (124 loc) · 3.8 KB

md_all.md

File metadata and controls

172 lines (124 loc) · 3.8 KB
title author preferred_vscode_theme
Everything About Markdown
Abhijit Roy
Light (Visual Studio C++)

Markdown

Tool

GitHub Repo

NOTES

  • Editor: VSCode (preferred)
  • Indentation size can be 2, 3, 4..anything. [2 recommended]

Syntax

  • Bold - Bold

  • italic - Italics

  • <ins>underline</ins> - underline a statement

  • Collapsible: Expand text with title

    Expand:

    Abhijit is a good boy

    Humand is a village in Chashm Rural District, Shahmirzad District, Mehdishahr County, Semnan Province, Iran. At the 2006 census, its existence was noted, but its population was not reported.

  • Collapsible: Expand code snippet/block with title

    NOTE: give a line break after summary tag

    M-1:

    View code: 
    std::cout << "With Iterator:" << std::endl;
for (std::vector<string>::iterator i = v.begin(); i != v.end(); ++i)
{
 std::cout << *i << std::endl;
}

  • Single line code snippet - code

  • Multiple-line code snippet -

    std::string s = "hello";

  • Image from HTTP link

    • 1
    <p align="center">
  <img src="https://github.com/DrifeCommunity/Documentation/blob/master/Images/DRIFE-Governance.png" alt="DRIFE_governance" width="550" height="510">
</p>
    • 2 with no width or height
      ![eos_image](http://url/to/img.png)

  • Image from local folder

    Within a git repository, it is done like this:

    NOTE: It is a relative path

    ![auto_fetch Image](./images/Fork/auto_fetch.png)
![Repository Image](./Sessions/Session%201/images/repository.jpg)

    Try alt+m from inside a ST3 application to view if it is shown.

    Example: Look at the relative path in the image link
    The directory is like this:

  |-- libs
  |   |-- Dash
  |   |   |-- dash.md
  |   |   |-- examples
  |   |   |   |-- 1_demo.py
  |   |   |   |-- 2_hello.png
  |   |   |   |-- 2_hello.py
  |   |   |   |-- 3_children.py
  |   |   |   |-- kill_port.bat
  |   |   |   `-- practice.py
  |   |   `-- images
  |   |       |-- console.png
  |   |       `-- console_open_url.png

Now, in dash.md file, the image - console.png will be referred as this:

    <p align="center">
      <img src="./images/console.png" alt="console Image" width="" height="">
    </p>

NOTE: the image link is ./images/console.png, NOT this - ./libs/Dash/images/console.png. So, it's a relative path w.r.t dash.md file (where the image is referenced).

  • Highlight console
foo@bar:~$ whoami
foo
  • Highlight shell
wc -l en_US.twitter.txt
  • New page
<div style="page-break-after: always;"></div>
  • Embed Videos
[[embed url=http://www.youtube.com/watch?v=6YbBmqUnoQM]]

  • Mermaid

  • Create a badge Version Actions Status

  • Create book with mdbook

    • Installation
    cargo install mdbook
    • Create a book
    mdbook init

  • Create a mindmap with this vscode extension

  • For Maths equation, refer this. E.g. $\sqrt{3x-1}+(1+x)^2$

  • To show difference in a file, write like this:

    - altogether
+ together

  • Note with purple color

Important

ds

sfds