1"use strict";(globalThis.webpackChunkdraftail_org=globalThis.webpackChunkdraftail_org||[]).push([[6052],{28453:(e,t,s)=>{s.d(t,{R:()=>i,x:()=>d});var r=s(96540);const o={},n=r.createContext(o);function i(e){const t=r.useContext(n);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(n.Provider,{value:t},e.children)}},65827:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>d,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"user-guides/markdown-support","title":"Markdown support","description":"Draftail supports formatting content with Markdown markup. If you\u2019ve never heard of Markdown this might sound like too much, but in reality it\u2019s really simple, and makes for a much faster content editing experience, with less strange keyboard shortcuts to remember.","source":"@site/docs/user-guides/markdown-support.md","sourceDirName":"user-guides","slug":"/user-guides/markdown-support","permalink":"/docs/next/user-guides/markdown-support","draft":false,"unlisted":false,"editUrl":"https://github.com/thibaudcolas/draftail.org/edit/main/docs/user-guides/markdown-support.md","tags":[],"version":"current","lastUpdatedBy":"Thibaud Colas","lastUpdatedAt":1763729128000,"frontMatter":{"id":"markdown-support","title":"Markdown support"},"sidebar":"docs","previous":{"title":"Keyboard shortcuts","permalink":"/docs/next/user-guides/keyboard-shortcuts"},"next":{"title":"API reference","permalink":"/docs/next/reference/api"}}');var o=s(74848),n=s(28453);const i={id:"markdown-support",title:"Markdown support"},d=void 0,a={},l=[{value:"Heading levels",id:"heading-levels",level:2},{value:"Bold, italic, and more",id:"bold-italic-and-more",level:2},{value:"More shortcuts",id:"more-shortcuts",level:2}];function c(e){const t={a:"a",code:"code",del:"del",em:"em",h2:"h2",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(t.p,{children:["Draftail supports formatting content with ",(0,o.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/Markdown",children:"Markdown"})," markup. If you\u2019ve never heard of Markdown this might sound like too much, but in reality it\u2019s really simple, and makes for a much faster content editing experience, with less strange keyboard shortcuts to remember."]}),"\n",(0,o.jsx)(t.p,{children:"Markdown formatting isn\u2019t actually being
1kept around in the editor \u2013 it just serves as a shortcut to format content faster. Here are a few examples:"}),"\n",(0,o.jsx)(t.h2,{id:"heading-levels",children:"Heading levels"}),"\n",(0,o.jsxs)(t.p,{children:["Heading levels can easily be formatted with the ",(0,o.jsx)(t.code,{children:"#"}),", ",(0,o.jsx)(t.code,{children:"##"}),", ",(0,o.jsx)(t.code,{children:"###"}),", ",(0,o.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/Markdown",children:"Markdown"}),"-style shortcuts. For a heading level 3, use three hash signs \u2013 ",(0,o.jsx)(t.code,{children:"###"})," followed by a space at the start of a line:"]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"Editor screenshot showing Markdown shortcuts",src:s(88737).A+"",width:"623",height:"202"})}),"\n",(0,o.jsx)(t.h2,{id:"bold-italic-and-more",children:"Bold, italic, and more"}),"\n",(0,o.jsx)(t.p,{children:"It\u2019s also possible to use Markdown shortcuts for inline formatting, not just at the beginning of a line:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:["Use ",(0,o.jsx)(t.code,{children:"**"}),(0,o.jsx)(t.strong,{children:"double asterisks"}),(0,o.jsx)(t.code,{children:"**"})," for bold text."]}),"\n",(0,o.jsxs)(t.li,{children:["Use ",(0,o.jsx)(t.code,{children:"_"}),(0,o.jsx)(t.em,{children:"underscores"}),(0,o.jsx)(t.code,{children:"_"})," for italicized text."]}),"\n",(0,o.jsxs)(t.li,{children:["Use ",(0,o.jsx)(t.code,{children:"~"}),(0,o.jsx)(t.del,{children:"tilde"}),(0,o.jsx)(t.code,{children:"~"})," to strike through text."]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"more-shortcuts",children:"More shortcuts"}),"\n",(0,o.jsxs)(t.p,{children:["Please have a look at the ",(0,o.jsx)(t.a,{href:"/docs/next/user-guides/keyboard-shortcuts",children:"full list of keyboard shortcuts"})," to see all supported Markdown shortcuts."]})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(c,{...e})}):c(e)}},88737:(e,t,s)=>{s.d(t,{A:()=>r});const r=s.p+"assets/images/markdown-shortcuts-6c5ff134357748f650d44805eb8bdc00.gif"}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.