de-intern-guide/assets/js/0ab13595.4413885a.js

"use strict";(self.webpackChunkde_intern_tutorial=self.webpackChunkde_intern_tutorial||[]).push([[617],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>w});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),c=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=c(e.components);return r.createElement(d.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),u=c(n),m=a,w=u["".concat(d,".").concat(m)]||u[m]||p[m]||i;return n?r.createElement(w,o(o({ref:t},s),{},{components:n})):r.createElement(w,o({ref:t},s))}));function w(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var c=2;c<i;c++)o[c]=n[c];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"},9351:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:2},o="\ud83d\udcdd Markdown",l={unversionedId:"technical-writing/markdown",id:"technical-writing/markdown",title:"\ud83d\udcdd Markdown",description:"Markdown is a markup language that is very useful for taking notes and writing documentation.",source:"@site/docs/technical-writing/markdown.md",sourceDirName:"technical-writing",slug:"/technical-writing/markdown",permalink:"/de-intern-guide/technical-writing/markdown",draft:!1,editUrl:"https://github.com/dathere/de-intern-guide/tree/main/docs/technical-writing/markdown.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"guideSidebar",previous:{title:"\ud83d\uddfa Technical Writing Overview",permalink:"/de-intern-guide/technical-writing/technical-writing-overview"},next:{title:"\u2615 Daily Standups",permalink:"/de-intern-guide/technical-writing/daily-standups"}},d={},c=[{value:"\ud83d\udcda Markdown Resources",id:"-markdown-resources",level:2},{value:"\ud83c\udfeb Learn Markdown",id:"-learn-markdown",level:3},{value:"\ud83d\udcd3 Markdown Editors",id:"-markdown-editors",level:3}],s={toc:c},u="wrapper";function p(e){let{components:t,...n}=e;return(0,a.kt)(u,(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"-markdown"},"\ud83d\udcdd Markdown"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Markdown")," is a markup language that is very useful for taking notes and writing documentation."),(0,a.kt)("p",null,"In fact, the page you're reading right now is built based on Markdown!"),(0,a.kt)("h2",{id:"-markdown-resources"},"\ud83d\udcda Markdown Resources"),(0,a.kt)("h3",{id:"-learn-markdown"},"\ud83c\udfeb Learn Markdown"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://www.markdownguide.org/"},"Markdown Guide")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://www.markdownguide.org/cheat-sheet/"},"Markdown Cheatsheet"))),(0,a.kt)("h3",{id:"-markdown-editors"},"\ud83d\udcd3 Markdown Editors"),(0,a.kt)("p",null,"Here are some Markdown editors you can use for taking notes:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://obsidian.md/"},"Obsidian")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://www.notion.so/"},"Notion"))),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"These programs often have extra features that can be useful for taking notes, such as the ability to create kanban boards, embed images, and more. However, they do support Markdown. Also, you can instead make a new Markdown file in your favorite text editor like Visual Studio Code by saving a file with the ",(0,a.kt)("inlineCode",{parentName:"p"},".md")," extension.")))}p.isMDXComponent=!0}}]);