Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
["'])(?.*?)\1/,ue=/\{(?<range>[\d,-]+)\}/,me={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}},he={...me,lua:{start:"--",end:""},wasm:{start:"\\;\\;",end:""},tex:{start:"%",end:""},vb:{start:"['\u2018\u2019]",end:""},vbnet:{start:"(?:_\\s*)?['\u2018\u2019]",end:""},rem:{start:"[Rr][Ee][Mm]\\b",end:""},f90:{start:"!",end:""},ml:{start:"\\(\\*",end:"\\*\\)"},cobol:{start:"\\*>",end:""}},pe=Object.keys(me);function fe(e,t){const n=e.map((e=>{const{start:n,end:s}=he[e];return`(?:${n}\\s*(${t.flatMap((e=>[e.line,e.block?.start,e.block?.end].filter(Boolean))).join("|")})\\s*${s})`})).join("|");return new RegExp(`^\\s*(?:${n})\\s*$`)}function xe(e,t){let n=e.replace(/\n$/,"");const{language:s,magicComments:a,metastring:o}=t;if(o&&ue.test(o)){const e=o.match(ue).groups.range;if(0===a.length)throw new Error(`A highlight range has been given in code block's metastring (\`\`\` ${o}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`);const t=a[0].className,s=re()(e).filter((e=>e>0)).map((e=>[e-1,[t]]));return{lineClassNames:Object.fromEntries(s),code:n}}if(void 0===s)return{lineClassNames:{},code:n};const i=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return fe(["js","jsBlock"],t);case"jsx":case"tsx":return fe(["js","jsBlock","jsx"],t);case"html":return fe(["js","jsBlock","html"],t);case"python":case"py":case"bash":return fe(["bash"],t);case"markdown":case"md":return fe(["html","jsx","bash"],t);case"tex":case"latex":case"matlab":return fe(["tex"],t);case"lua":case"haskell":case"sql":return fe(["lua"],t);case"wasm":return fe(["wasm"],t);case"vb":case"vba":case"visual-basic":return fe(["vb","rem"],t);case"vbnet":return fe(["vbnet","rem"],t);case"batch":return fe(["rem"],t);case"basic":return fe(["rem","f90"],t);case"fsharp":return fe(["js","ml"],t);case"ocaml":case"sml":return fe(["ml"],t);case"fortran":return fe(["f90"],t);case"cobol":return fe(["cobol"],t);default:return fe(pe,t)}}(s,a),l=n.split("\n"),c=Object.fromEntries(a.map((e=>[e.className,{start:0,range:""}]))),r=Object.fromEntries(a.filter((e=>e.line)).map((e=>{let{className:t,line:n}=e;return[n,t]}))),d=Object.fromEntries(a.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.start,t]}))),u=Object.fromEntries(a.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.end,t]})));for(let h=0;h<l.length;){const e=l[h].match(i);if(!e){h+=1;continue}const t=e.slice(1).find((e=>void 0!==e));r[t]?c[r[t]].range+=`${h},`:d[t]?c[d[t]].start=h:u[t]&&(c[u[t]].range+=`${c[u[t]].start}-${h-1},`),l.splice(h,1)}n=l.join("\n");const m={};return Object.entries(c).forEach((e=>{let[t,{range:n}]=e;re()(n).forEach((e=>{m[e]??=[],m[e].push(t)}))})),{lineClassNames:m,code:n}}const be={codeBlockContainer:"codeBlockContainer_ZGJx"};function ge(e){let{as:t,...n}=e;const s=function(e){const t={color:"--prism-color",backgroundColor:"--prism-background-color"},n={};return Object.entries(e.plain).forEach((e=>{let[s,a]=e;const o=t[s];o&&"string"==typeof a&&(n[o]=a)})),n}(le());return(0,i.jsx)(t,{...n,style:s,className:(0,u.A)(n.className,be.codeBlockContainer,b.G.common.codeBlock)})}const ve={codeBlockContent:"codeBlockContent_qZBB",codeBlockTitle:"codeBlockTitle_zAEH",codeBlock:"codeBlock_TAPP",codeBlockStandalone:"codeBlockStandalone_K9VJ",codeBlockLines:"codeBlockLines_AdAo",codeBlockLinesWithNumbering:"codeBlockLinesWithNumbering_p5De",buttonGroup:"buttonGroup_TNwR"};function je(e){let{children:t,className:n}=e;return(0,i.jsx)(ge,{as:"pre",tabIndex:0,className:(0,u.A)(ve.codeBlockStandalone,"thin-scrollbar",n),children:(0,i.jsx)("code",{className:ve.codeBlockLines,children:t})})}const Ne={attributes:!0,characterData:!0,childList:!0,subtree:!0};function Ae(e,t){const[n,a]=(0,s.useState)(),i=(0,s.useCallback)((()=>{a(e.current?.closest("[role=tabpanel][hidden]"))}),[e,a]);(0,s.useEffect)((()=>{i()}),[i]),function(e,t,n){void 0===n&&(n=Ne);const a=(0,o._q)(t),i=(0,o.Be)(n);(0,s.useEffect)((()=>{const t=new MutationObserver(a);return e&&t.observe(e,i),()=>t.disconnect()}),[e,a,i])}(n,(e=>{e.forEach((e=>{"attributes"===e.type&&"hidden"===e.attributeName&&(t(),i())}))}),{attributes:!0,characterData:!1,childList:!1,subtree:!1})}var Ce=n(4370);const ke={codeLine:"codeLine_DPDv",codeLineNumber:"codeLineNumber_YxQB",codeLineContent:"codeLineContent_SOIp"};function Le(e){let{line:t,classNames:n,showLineNumbers:s,getLineProps:a,getTokenProps:o}=e;1===t.length&&"\n"===t[0].content&&(t[0].content="");const l=a({line:t,className:(0,u.A)(n,s&&ke.codeLine)}),c=t.map(((e,t)=>(0,i.jsx)("span",{...o({token:e,key:t})},t)));return(0,i.jsxs)("span",{...l,children:[s?(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("span",{className:ke.codeLineNumber}),(0,i.jsx)("span",{className:ke.codeLineContent,children:c})]}):c,(0,i.jsx)("br",{})]})}function ye(e){return(0,i.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,i.jsx)("path",{fill:"currentColor",d:"M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"})})}function _e(e){return(0,i.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,i.jsx)("path",{fill:"currentColor",d:"M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"})})}const Be={copyButtonCopied:"copyButtonCopied_Mzdr",copyButtonIcons:"copyButtonIcons_MVhB",copyButtonIcon:"copyButtonIcon_yxgH",copyButtonSuccessIcon:"copyButtonSuccessIcon_QJLJ"};function we(e){let{code:t,className:n}=e;const[a,o]=(0,s.useState)(!1),l=(0,s.useRef)(void 0),c=(0,s.useCallback)((()=>{!function(e,t){let{target:n=document.body}=void 0===t?{}:t;if("string"!=typeof e)throw new TypeError(`Expected parameter \`text\` to be a \`string\`, got \`${typeof e}\`.`);const s=document.createElement("textarea"),a=document.activeElement;s.value=e,s.setAttribute("readonly",""),s.style.contain="strict",s.style.position="absolute",s.style.left="-9999px",s.style.fontSize="12pt";const o=document.getSelection(),i=o.rangeCount>0&&o.getRangeAt(0);n.append(s),s.select(),s.selectionStart=0,s.selectionEnd=e.length;let l=!1;try{l=document.execCommand("copy")}catch{}s.remove(),i&&(o.removeAllRanges(),o.addRange(i)),a&&a.focus()}(t),o(!0),l.current=window.setTimeout((()=>{o(!1)}),1e3)}),[t]);return(0,s.useEffect)((()=>()=>window.clearTimeout(l.current)),[]),(0,i.jsx)("button",{type:"button","aria-label":a?(0,g.T)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,g.T)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,g.T)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,u.A)("clean-btn",n,Be.copyButton,a&&Be.copyButtonCopied),onClick:c,children:(0,i.jsxs)("span",{className:Be.copyButtonIcons,"aria-hidden":"true",children:[(0,i.jsx)(ye,{className:Be.copyButtonIcon}),(0,i.jsx)(_e,{className:Be.copyButtonSuccessIcon})]})})}function Te(e){return(0,i.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,i.jsx)("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"})})}const Ee={wordWrapButtonIcon:"wordWrapButtonIcon_SMj9",wordWrapButtonEnabled:"wordWrapButtonEnabled_vR9E"};function He(e){let{className:t,onClick:n,isEnabled:s}=e;const a=(0,g.T)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return(0,i.jsx)("button",{type:"button",onClick:n,className:(0,u.A)("clean-btn",t,s&&Ee.wordWrapButtonEnabled),"aria-label":a,title:a,children:(0,i.jsx)(Te,{className:Ee.wordWrapButtonIcon,"aria-hidden":"true"})})}function Me(e){let{children:t,className:n="",metastring:a,title:o,showLineNumbers:l,language:c}=e;const{prism:{defaultLanguage:r,magicComments:d}}=(0,S.p)(),m=function(e){return e?.toLowerCase()}(c??function(e){const t=e.split(" ").find((e=>e.startsWith("language-")));return t?.replace(/language-/,"")}(n)??r),h=le(),p=function(){const[e,t]=(0,s.useState)(!1),[n,a]=(0,s.useState)(!1),o=(0,s.useRef)(null),i=(0,s.useCallback)((()=>{const n=o.current.querySelector("code");e?n.removeAttribute("style"):(n.style.whiteSpace="pre-wrap",n.style.overflowWrap="anywhere"),t((e=>!e))}),[o,e]),l=(0,s.useCallback)((()=>{const{scrollWidth:e,clientWidth:t}=o.current,n=e>t||o.current.querySelector("code").hasAttribute("style");a(n)}),[o]);return Ae(o,l),(0,s.useEffect)((()=>{l()}),[e,l]),(0,s.useEffect)((()=>(window.addEventListener("resize",l,{passive:!0}),()=>{window.removeEventListener("resize",l)})),[l]),{codeBlockRef:o,isEnabled:e,isCodeScrollable:n,toggle:i}}(),f=function(e){return e?.match(de)?.groups.title??""}(a)||o,{lineClassNames:x,code:b}=xe(t,{metastring:a,language:m,magicComments:d}),g=l??function(e){return Boolean(e?.includes("showLineNumbers"))}(a);return(0,i.jsxs)(ge,{as:"div",className:(0,u.A)(n,m&&!n.includes(`language-${m}`)&&`language-${m}`),children:[f&&(0,i.jsx)("div",{className:ve.codeBlockTitle,children:f}),(0,i.jsxs)("div",{className:ve.codeBlockContent,children:[(0,i.jsx)(Ce.f4,{theme:h,code:b,language:m??"text",children:e=>{let{className:t,style:n,tokens:s,getLineProps:a,getTokenProps:o}=e;return(0,i.jsx)("pre",{tabIndex:0,ref:p.codeBlockRef,className:(0,u.A)(t,ve.codeBlock,"thin-scrollbar"),style:n,children:(0,i.jsx)("code",{className:(0,u.A)(ve.codeBlockLines,g&&ve.codeBlockLinesWithNumbering),children:s.map(((e,t)=>(0,i.jsx)(Le,{line:e,getLineProps:a,getTokenProps:o,classNames:x[t],showLineNumbers:g},t)))})})}}),(0,i.jsxs)("div",{className:ve.buttonGroup,children:[(p.isEnabled||p.isCodeScrollable)&&(0,i.jsx)(He,{className:ve.codeButton,onClick:()=>p.toggle(),isEnabled:p.isEnabled}),(0,i.jsx)(we,{className:ve.codeButton,code:b})]})]})]})}function Ie(e){let{children:t,...n}=e;const a=(0,oe.A)(),o=function(e){return s.Children.toArray(e).some((e=>(0,s.isValidElement)(e)))?e:Array.isArray(e)?e.join(""):e}(t),l="string"==typeof o?Me:je;return(0,i.jsx)(l,{...n,children:o},String(a))}function Se(e){return(0,i.jsx)("code",{...e})}var Ue=n(6357);const Re={details:"details_B4FW",isBrowser:"isBrowser_Cof9",collapsibleContent:"collapsibleContent_VYua"};function ze(e){return!!e&&("SUMMARY"===e.tagName||ze(e.parentElement))}function Ve(e,t){return!!e&&(e===t||Ve(e.parentElement,t))}function Oe(e){let{summary:t,children:n,...a}=e;(0,Ue.A)().collectAnchor(a.id);const o=(0,oe.A)(),l=(0,s.useRef)(null),{collapsed:c,setCollapsed:r}=(0,I.u)({initialState:!a.open}),[d,m]=(0,s.useState)(a.open),h=s.isValidElement(t)?t:(0,i.jsx)("summary",{children:t??"Details"});return(0,i.jsxs)("details",{...a,ref:l,open:d,"data-collapsed":c,className:(0,u.A)(Re.details,o&&Re.isBrowser,a.className),onMouseDown:e=>{ze(e.target)&&e.detail>1&&e.preventDefault()},onClick:e=>{e.stopPropagation();const t=e.target;ze(t)&&Ve(t,l.current)&&(e.preventDefault(),c?(r(!1),m(!0)):r(!0))},children:[h,(0,i.jsx)(I.N,{lazy:!1,collapsed:c,disableSSRStyle:!0,onCollapseTransitionEnd:e=>{r(e),m(!e)},children:(0,i.jsx)("div",{className:Re.collapsibleContent,children:n})})]})}const De={details:"details_SZgV"},Pe="alert alert--info";function We(e){let{...t}=e;return(0,i.jsx)(Oe,{...t,className:(0,u.A)(Pe,De.details,t.className)})}function Ge(e){const t=s.Children.toArray(e.children),n=t.find((e=>s.isValidElement(e)&&"summary"===e.type)),a=(0,i.jsx)(i.Fragment,{children:t.filter((e=>e!==n))});return(0,i.jsx)(We,{...e,summary:n,children:a})}function $e(e){return(0,i.jsx)(ne.A,{...e})}const Fe={containsTaskList:"containsTaskList__YnT"};function qe(e){if(void 0!==e)return(0,u.A)(e,e?.includes("contains-task-list")&&Fe.containsTaskList)}const Je={img:"img__Ss2"};function Ye(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=s.Children.toArray(e),n=t.find((e=>s.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),a=t.filter((e=>e!==n)),o=n?.props.children;return{mdxAdmonitionTitle:o,rest:a.length>0?(0,i.jsx)(i.Fragment,{children:a}):null}}(e.children),a=e.title??t;return{...e,...a&&{title:a},children:n}}const Ze={admonition:"admonition_IZjC",admonitionHeading:"admonitionHeading_uVvU",admonitionIcon:"admonitionIcon_HiR3",admonitionContent:"admonitionContent_bl22"};function Qe(e){let{type:t,className:n,children:s}=e;return(0,i.jsx)("div",{className:(0,u.A)(b.G.common.admonition,b.G.common.admonitionType(t),Ze.admonition,n),children:s})}function Ke(e){let{icon:t,title:n}=e;return(0,i.jsxs)("div",{className:Ze.admonitionHeading,children:[(0,i.jsx)("span",{className:Ze.admonitionIcon,children:t}),n]})}function Xe(e){let{children:t}=e;return t?(0,i.jsx)("div",{className:Ze.admonitionContent,children:t}):null}function et(e){const{type:t,icon:n,title:s,children:a,className:o}=e;return(0,i.jsxs)(Qe,{type:t,className:o,children:[(0,i.jsx)(Ke,{title:s,icon:n}),(0,i.jsx)(Xe,{children:a})]})}function tt(e){return(0,i.jsx)("svg",{viewBox:"0 0 14 16",...e,children:(0,i.jsx)("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"})})}const nt={icon:(0,i.jsx)(tt,{}),title:(0,i.jsx)(g.A,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)",children:"note"})};function st(e){return(0,i.jsx)(et,{...nt,...e,className:(0,u.A)("alert alert--secondary",e.className),children:e.children})}function at(e){return(0,i.jsx)("svg",{viewBox:"0 0 12 16",...e,children:(0,i.jsx)("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"})})}const ot={icon:(0,i.jsx)(at,{}),title:(0,i.jsx)(g.A,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)",children:"tip"})};function it(e){return(0,i.jsx)(et,{...ot,...e,className:(0,u.A)("alert alert--success",e.className),children:e.children})}function lt(e){return(0,i.jsx)("svg",{viewBox:"0 0 14 16",...e,children:(0,i.jsx)("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"})})}const ct={icon:(0,i.jsx)(lt,{}),title:(0,i.jsx)(g.A,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)",children:"info"})};function rt(e){return(0,i.jsx)(et,{...ct,...e,className:(0,u.A)("alert alert--info",e.className),children:e.children})}function dt(e){return(0,i.jsx)("svg",{viewBox:"0 0 16 16",...e,children:(0,i.jsx)("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"})})}const ut={icon:(0,i.jsx)(dt,{}),title:(0,i.jsx)(g.A,{id:"theme.admonition.warning",description:"The default label used for the Warning admonition (:::warning)",children:"warning"})};function mt(e){return(0,i.jsx)("svg",{viewBox:"0 0 12 16",...e,children:(0,i.jsx)("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"})})}const ht={icon:(0,i.jsx)(mt,{}),title:(0,i.jsx)(g.A,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)",children:"danger"})};const pt={icon:(0,i.jsx)(dt,{}),title:(0,i.jsx)(g.A,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)",children:"caution"})};const ft={...{note:st,tip:it,info:rt,warning:function(e){return(0,i.jsx)(et,{...ut,...e,className:(0,u.A)("alert alert--warning",e.className),children:e.children})},danger:function(e){return(0,i.jsx)(et,{...ht,...e,className:(0,u.A)("alert alert--danger",e.className),children:e.children})}},...{secondary:e=>(0,i.jsx)(st,{title:"secondary",...e}),important:e=>(0,i.jsx)(rt,{title:"important",...e}),success:e=>(0,i.jsx)(it,{title:"success",...e}),caution:function(e){return(0,i.jsx)(et,{...pt,...e,className:(0,u.A)("alert alert--warning",e.className),children:e.children})}}};function xt(e){const t=Ye(e),n=(s=t.type,ft[s]||(console.warn(`No admonition component found for admonition type "${s}". Using Info as fallback.`),ft.info));var s;return(0,i.jsx)(n,{...t})}var bt=n(1540);const gt={Head:ae.A,details:Ge,Details:Ge,code:function(e){return function(e){return void 0!==e.children&&s.Children.toArray(e.children).every((e=>"string"==typeof e&&!e.includes("\n")))}(e)?(0,i.jsx)(Se,{...e}):(0,i.jsx)(Ie,{...e})},a:function(e){return(0,i.jsx)(A.A,{...e})},pre:function(e){return(0,i.jsx)(i.Fragment,{children:e.children})},ul:function(e){return(0,i.jsx)("ul",{...e,className:qe(e.className)})},li:function(e){return(0,Ue.A)().collectAnchor(e.id),(0,i.jsx)("li",{...e})},img:function(e){return(0,i.jsx)("img",{decoding:"async",loading:"lazy",...e,className:(t=e.className,(0,u.A)(t,Je.img))});var t},h1:e=>(0,i.jsx)($e,{as:"h1",...e}),h2:e=>(0,i.jsx)($e,{as:"h2",...e}),h3:e=>(0,i.jsx)($e,{as:"h3",...e}),h4:e=>(0,i.jsx)($e,{as:"h4",...e}),h5:e=>(0,i.jsx)($e,{as:"h5",...e}),h6:e=>(0,i.jsx)($e,{as:"h6",...e}),admonition:xt,mermaid:bt.A};function vt(e){let{children:t}=e;return(0,i.jsx)(se.x,{components:gt,children:t})}function jt(e){let{children:t}=e;const n=function(){const{metadata:e,frontMatter:t,contentTitle:n}=r();return t.hide_title||void 0!==n?null:e.title}();return(0,i.jsxs)("div",{className:(0,u.A)(b.G.docs.docMarkdown,"markdown"),children:[n&&(0,i.jsx)("header",{children:(0,i.jsx)(ne.A,{as:"h1",children:n})}),(0,i.jsx)(vt,{children:t})]})}var Nt=n(3021);function At(){return(0,i.jsx)(g.A,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function Ct(){return(0,i.jsx)(g.A,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function kt(){return(0,i.jsx)(ae.A,{children:(0,i.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}function Lt(e){let{className:t}=e;return(0,i.jsx)(xt,{type:"caution",title:(0,i.jsx)(At,{}),className:(0,u.A)(t,b.G.common.unlistedBanner),children:(0,i.jsx)(Ct,{})})}function yt(e){return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(kt,{}),(0,i.jsx)(Lt,{...e})]})}const _t={docItemContainer:"docItemContainer_Rv5Z",docItemCol:"docItemCol_YAwJ"};function Bt(e){let{children:t}=e;const n=function(){const{frontMatter:e,toc:t}=r(),n=(0,m.l)(),s=e.hide_table_of_contents,a=!s&&t.length>0;return{hidden:s,mobile:a?(0,i.jsx)(Z,{}):void 0,desktop:!a||"desktop"!==n&&"ssr"!==n?void 0:(0,i.jsx)(te,{})}}(),{metadata:{unlisted:s}}=r();return(0,i.jsxs)("div",{className:"row",children:[(0,i.jsxs)("div",{className:(0,u.A)("col",!n.hidden&&_t.docItemCol),children:[s&&(0,i.jsx)(yt,{}),(0,i.jsx)(f.A,{}),(0,i.jsxs)("div",{className:_t.docItemContainer,children:[(0,i.jsxs)("article",{children:[(0,i.jsx)(Nt.A,{}),(0,i.jsx)(x.A,{}),n.mobile,(0,i.jsx)(jt,{children:t}),(0,i.jsx)(M,{})]}),(0,i.jsx)(p,{})]})]}),n.desktop&&(0,i.jsx)("div",{className:"col col--3",children:n.desktop})]})}function wt(e){const t=`docs-doc-id-${e.content.metadata.id}`,n=e.content;return(0,i.jsx)(c,{content:e.content,children:(0,i.jsxs)(a.e3,{className:t,children:[(0,i.jsx)(d,{}),(0,i.jsx)(Bt,{children:(0,i.jsx)(n,{})})]})})}},5119:(e,t,n)=>{"use strict";n.d(t,{A:()=>c});n(4041);var s=n(9082),a=n(4357),o=n(2436),i=n(1085);function l(e){const{permalink:t,title:n,subLabel:s,isNext:l}=e;return(0,i.jsxs)(o.A,{className:(0,a.A)("pagination-nav__link",l?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t,children:[s&&(0,i.jsx)("div",{className:"pagination-nav__sublabel",children:s}),(0,i.jsx)("div",{className:"pagination-nav__label",children:n})]})}function c(e){const{previous:t,next:n}=e;return(0,i.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,s.T)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"}),children:[t&&(0,i.jsx)(l,{...t,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc",children:"Previous"})}),n&&(0,i.jsx)(l,{...n,subLabel:(0,i.jsx)(s.A,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc",children:"Next"}),isNext:!0})]})}},2101:(e,t,n)=>{"use strict";n.d(t,{A:()=>c});n(4041);var s=n(4357),a=n(9082),o=n(7473),i=n(6738),l=n(1085);function c(e){let{className:t}=e;const n=(0,i.r)();return n.badge?(0,l.jsx)("span",{className:(0,s.A)(t,o.G.docs.docVersionBadge,"badge badge--secondary"),children:(0,l.jsx)(a.A,{id:"theme.docs.versionBadge.label",values:{versionLabel:n.label},children:"Version: {versionLabel}"})}):null}},1524:(e,t,n)=>{"use strict";n.d(t,{A:()=>x});n(4041);var s=n(4357),a=n(396),o=n(2436),i=n(9082),l=n(8016),c=n(7473),r=n(9599),d=n(6738),u=n(1085);const m={unreleased:function(e){let{siteTitle:t,versionMetadata:n}=e;return(0,u.jsx)(i.A,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:(0,u.jsx)("b",{children:n.label})},children:"This is unreleased documentation for {siteTitle} {versionLabel} version."})},unmaintained:function(e){let{siteTitle:t,versionMetadata:n}=e;return(0,u.jsx)(i.A,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:(0,u.jsx)("b",{children:n.label})},children:"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."})}};function h(e){const t=m[e.versionMetadata.banner];return(0,u.jsx)(t,{...e})}function p(e){let{versionLabel:t,to:n,onClick:s}=e;return(0,u.jsx)(i.A,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:(0,u.jsx)("b",{children:(0,u.jsx)(o.A,{to:n,onClick:s,children:(0,u.jsx)(i.A,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label",children:"latest version"})})})},children:"For up-to-date documentation, see the {latestVersionLink} ({versionLabel})."})}function f(e){let{className:t,versionMetadata:n}=e;const{siteConfig:{title:o}}=(0,a.A)(),{pluginId:i}=(0,l.vT)({failfast:!0}),{savePreferredVersionName:d}=(0,r.g1)(i),{latestDocSuggestion:m,latestVersionSuggestion:f}=(0,l.HW)(i),x=m??(b=f).docs.find((e=>e.id===b.mainDocId));var b;return(0,u.jsxs)("div",{className:(0,s.A)(t,c.G.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert",children:[(0,u.jsx)("div",{children:(0,u.jsx)(h,{siteTitle:o,versionMetadata:n})}),(0,u.jsx)("div",{className:"margin-top--md",children:(0,u.jsx)(p,{versionLabel:f.label,to:x.path,onClick:()=>d(f.name)})})]})}function x(e){let{className:t}=e;const n=(0,d.r)();return n.banner?(0,u.jsx)(f,{className:t,versionMetadata:n}):null}},1431:(e,t)=>{function n(e){let t,n=[];for(let s of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(s))n.push(parseInt(s,10));else if(t=s.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,s,a,o]=t;if(s&&o){s=parseInt(s),o=parseInt(o);const e=s<o?1:-1;"-"!==a&&".."!==a&&"\u2025"!==a||(o+=e);for(let t=s;t!==o;t+=e)n.push(t)}}return n}t.default=n,e.exports=n},1184:(e,t,n)=>{"use strict";n.d(t,{R:()=>i,x:()=>l});var s=n(4041);const a={},o=s.createContext(a);function i(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/222.ccadd868.js b/assets/js/222.ccadd868.js new file mode 100644 index 000000000..2d2ea135d --- /dev/null +++ b/assets/js/222.ccadd868.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sigma_website=self.webpackChunk_sigma_website||[]).push([[222],{2757:(e,t,i)=>{i.d(t,{A:()=>c});i(4041);var n=i(4357),s=i(9082),o=i(4441),r=i(1085);function c(e){let{className:t}=e;return(0,r.jsx)("main",{className:(0,n.A)("container margin-vert--xl",t),children:(0,r.jsx)("div",{className:"row",children:(0,r.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,r.jsx)(o.A,{as:"h1",className:"hero__title",children:(0,r.jsx)(s.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,r.jsx)("p",{children:(0,r.jsx)(s.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,r.jsx)("p",{children:(0,r.jsx)(s.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}},8222:(e,t,i)=>{i.r(t),i.d(t,{default:()=>a});var n=i(6090),s=(i(4041),i(9082)),o=i(145),r=i(1794),c=i(2757),d=i(1085);function h(){const e=(0,s.T)({id:"theme.NotFound.title",message:"Page Not Found"});return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(o.be,{title:e}),(0,d.jsx)(r.A,{children:(0,d.jsx)(c.A,{})})]})}function a(e){return"/"===(0,n.zy)().pathname?(0,d.jsxs)("div",{style:{display:"flex",flexDirection:"column",alignItems:"center",justifyContent:"center",height:"100vh",textAlign:"center"},children:[(0,d.jsxs)("div",{children:["The homepage of this website is not in the React-Router workflow: The sources are not in"," ",(0,d.jsx)("code",{children:"/src/pages"}),", but in"," ",(0,d.jsx)("strong",{children:(0,d.jsx)("code",{children:"/static/index.html"})})," ","instead."]}),(0,d.jsx)("br",{}),(0,d.jsx)("div",{children:"This page cannot be served in the development version, but you can edit its HTML code directly if it needs modifications."}),(0,d.jsx)("br",{}),(0,d.jsxs)("div",{children:["Please open"," ",(0,d.jsx)("a",{href:"/docs",children:(0,d.jsx)("strong",{children:(0,d.jsx)("code",{children:"/docs"})})})," ","to access the documentation."]})]}):(0,d.jsx)(d.Fragment,{children:(0,d.jsx)(h,{...e})})}}}]); \ No newline at end of file diff --git a/assets/js/4edc808e.04cce572.js b/assets/js/4edc808e.04cce572.js new file mode 100644 index 000000000..33daa138e --- /dev/null +++ b/assets/js/4edc808e.04cce572.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sigma_website=self.webpackChunk_sigma_website||[]).push([[308],{8149:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>g,frontMatter:()=>a,metadata:()=>d,toc:()=>h});var o=i(1085),n=i(1184);function r(e){const s={a:"a",code:"code",h2:"h2",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.p,{children:(0,o.jsx)(s.a,{href:"https://github.com/jacomyal/sigma.js/actions",children:(0,o.jsx)(s.img,{src:"https://github.com/jacomyal/sigma.js/workflows/Tests/badge.svg",alt:"Build Status"})})}),"\n",(0,o.jsx)("br",{}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.img,{alt:"Sigma.js",src:i(9061).A+"",width:"261",height:"69"})}),"\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:(0,o.jsx)(s.a,{href:"https://www.sigmajs.org/",children:"Website"})})," | ",(0,o.jsx)(s.strong,{children:(0,o.jsx)(s.a,{href:"https://www.sigmajs.org/docs",children:"Documentation"})})," | ",(0,o.jsx)(s.strong,{children:(0,o.jsx)(s.a,{href:"https://www.sigmajs.org/storybook",children:"Storybook"})})]}),"\n",(0,o.jsx)(s.hr,{}),"\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.a,{href:"https://www.sigmajs.org",children:"Sigma.js"})," is an open-source JavaScript library aimed at visualizing graphs of thousands of nodes and edges using WebGL, mainly developed by ",(0,o.jsx)(s.a,{href:"https://github.com/jacomyal",children:"@jacomyal"})," and ",(0,o.jsx)(s.a,{href:"https://github.com/Yomguithereal",children:"@Yomguithereal"}),", and built on top of ",(0,o.jsx)(s.a,{href:"https://graphology.github.io/",children:"graphology"}),"."]}),"\n",(0,o.jsx)(s.h2,{id:"how-to-use-in-your-project",children:"How to use in your project"}),"\n",(0,o.jsx)(s.p,{children:"To integrate sigma into your project, follow these simple steps:"}),"\n",(0,o.jsxs)(s.ol,{children:["\n",(0,o.jsxs)(s.li,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"Installation:"})," Add ",(0,o.jsx)(s.code,{children:"sigma"})," and ",(0,o.jsx)(s.code,{children:"graphology"})," to your project by running the following command:"]}),"\n",(0,o.jsx)(s.pre,{children:(0,o.jsx)(s.code,{className:"language-bash",children:"npm install sigma graphology\n"})}),"\n"]}),"\n",(0,o.jsxs)(s.li,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"Usage:"})," Import sigma into your JavaScript or TypeScript file:"]}),"\n",(0,o.jsx)(s.pre,{children:(0,o.jsx)(s.code,{className:"language-javascript",children:'import Graph from "graphology";\nimport Sigma from "sigma";\n'})}),"\n",(0,o.jsxs)(s.p,{children:["Then, create a new ",(0,o.jsx)(s.code,{children:"Sigma"})," instance with your graph data and target container:"]}),"\n",(0,o.jsx)(s.pre,{children:(0,o.jsx)(s.code,{className:"language-javascript",children:'const graph = new Graph();\ngraph.addNode("1", { label: "Node 1", x: 0, y: 0, size: 10, color: "blue" });\ngraph.addNode("2", { label: "Node 2", x: 1, y: 1, size: 20, color: "red" });\ngraph.addEdge("1", "2", { size: 5, color: "purple" });\n\nconst sigmaInstance = new Sigma(graph, document.getElementById("container"));\n'})}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(s.h2,{id:"how-to-develop-locally",children:"How to develop locally"}),"\n",(0,o.jsxs)(s.p,{children:["To run the ",(0,o.jsx)(s.a,{href:"https://storybook.js.org/",children:"Storybook"})," locally:"]}),"\n",(0,o.jsx)(s.pre,{children:(0,o.jsx)(s.code,{className:"language-bash",children:"git clone git@github.com:jacomyal/sigma.js.git\ncd sigma.js\nnpm install\nnpm run start\n"})}),"\n",(0,o.jsx)(s.p,{children:"This will open the Storybook in your web browser, which live reloads when you modify the stories or the package sources."}),"\n",(0,o.jsx)(s.h2,{id:"resources",children:"Resources"}),"\n",(0,o.jsxs)(s.ul,{children:["\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.strong,{children:"GitHub Project:"})," The source code and collaborative development efforts for Sigma.js are hosted on ",(0,o.jsx)(s.a,{href:"https://github.com/sigma",children:"GitHub"}),"."]}),"\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.strong,{children:"Website:"})," The official website, ",(0,o.jsx)(s.a,{href:"https://sigmajs.org",children:"sigmajs.org"}),", kindly designed by ",(0,o.jsx)(s.a,{href:"https://github.com/robindemourat/",children:"Robin de Mourat"})," from the ",(0,o.jsx)(s.a,{href:"https://medialab.sciencespo.fr/en/",children:"Sciences-Po m\xe9dialab"})," team, showcases the library's capabilities."]}),"\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.strong,{children:"Documentation:"})," A detailed documentation, built with ",(0,o.jsx)(s.a,{href:"https://docusaurus.io/",children:"Docusaurus"}),", is available at ",(0,o.jsx)(s.a,{href:"https://sigmajs.org/docs",children:"sigmajs.org/docs"}),". It provides extensive guides and API references for users."]}),"\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.strong,{children:"Storybook:"})," Interactive examples can be found at ",(0,o.jsx)(s.a,{href:"https://sigmajs.org/storybook",children:"sigmajs.org/storybook"}),"."]}),"\n",(0,o.jsxs)(s.li,{children:[(0,o.jsx)(s.strong,{children:"Demo:"})," A comprehensive demo, available at ",(0,o.jsx)(s.a,{href:"https://sigmajs.org/demo",children:"sigmajs.org/demo"}),", features a full-featured React-based web application utilizing Sigma.js."]}),"\n"]}),"\n",(0,o.jsx)(s.h2,{id:"how-to-contribute",children:"How to contribute"}),"\n",(0,o.jsxs)(s.p,{children:["You can contribute by submitting ",(0,o.jsx)(s.a,{href:"http://github.com/jacomyal/sigma.js/issues",children:"issues tickets"})," and proposing ",(0,o.jsx)(s.a,{href:"http://github.com/jacomyal/sigma.js/pulls",children:"pull requests"}),". Make sure that tests and linting pass before submitting any pull request."]}),"\n",(0,o.jsxs)(s.p,{children:["You can also browse the related documentation ",(0,o.jsx)(s.a,{href:"https://github.com/jacomyal/sigma.js/tree/main/CONTRIBUTING.md",children:"here"}),"."]})]})}function t(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(r,{...e})}):r(e)}const a={title:"Introduction",sidebar_position:1},c=void 0,d={id:"index",title:"Introduction",description:"",source:"@site/docs/index.mdx",sourceDirName:".",slug:"/",permalink:"/docs/",draft:!1,unlisted:!1,editUrl:"https://github.com/jacomyal/sigma.js/tree/main/packages/website/docs/index.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"Introduction",sidebar_position:1},sidebar:"tutorialSidebar",next:{title:"Quickstart Guide",permalink:"/docs/quickstart"}},l={},h=[];function u(e){return(0,o.jsx)(t,{})}function g(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(u,{...e})}):u()}},9061:(e,s,i)=>{i.d(s,{A:()=>o});const o="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQUAAABFCAYAAABDufNJAAABhGlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AcxV9TxSIVB4uoOGSoThZERRy1CkWoEGqFVh1MLv2CJg1Jiouj4Fpw8GOx6uDirKuDqyAIfoA4OzgpukiJ/0sKLWI8OO7Hu3uPu3eAUC8zzeoYBzTdNlOJuJjJropdrwiiHyFEMSgzy5iTpCR8x9c9Any9i/Es/3N/jh41ZzEgIBLPMsO0iTeIpzdtg/M+cYQVZZX4nHjMpAsSP3Jd8fiNc8FlgWdGzHRqnjhCLBbaWGljVjQ14iniqKrplC9kPFY5b3HWylXWvCd/YTinryxzneYwEljEEiSIUFBFCWXYiNGqk2IhRftxH/+Q65fIpZCrBEaOBVSgQXb94H/wu1srPznhJYXjQOeL43yMAF27QKPmON/HjtM4AYLPwJXe8lfqwMwn6bWWFj0CereBi+uWpuwBlzvAwJMhm7IrBWkK+TzwfkbflAX6boHuNa+35j5OH4A0dZW8AQ4OgdECZa/7vDvU3tu/Z5r9/QBfJXKfpHQEEgAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAAuIwAALiMBeKU/dgAAAAd0SU1FB+gDFgkLF2vnJl8AAAAZdEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAYeElEQVR42u2dfXRU5Z3HP797JySAvIn4AlFCEpVUxUoyia9dKtGuVivYemyrAvbsbl/Auj1nzyq427ctL7Z7dtej1u52a3mxVm1XsbbdbQutbbVKJsEqKiiZAJoARTAIISQk9/72j3sHbi53kknmDpmE+z1nzplzZ+7L89zn+T6/90c4QdhHzdj92NWCTgdQpBiY4nynQmCMwkGBze4pLYI2u//dMh6jbiIbDhAhQoScQnJ58WZqijvQ2YLWAtUhXLJOkXVFyPpiNjRHry9ChCFACs3UFB/BmmdDrSBTcvXgirYYsG4E5uqIICJEyENS2EfN2A+w5tnIAoExaf62XrE3C0aLgdkCMI2XN/j/tI1LawBsrCmKPUUwKoDZweTAQQNdOQ5zdaReRIiQJ6TQRNWiIDJQdKeBsU7RDWUk1mV7nyTxWkFqbOxaQSb7yQHkwXLqVkWvNUKEQSKFJPFaRZcEqAnrTawHS9i4OVcPvp2ZFRbmfUDcr1YIsiwMEooQISKF/kkHSxSZ7zucMDAfDFIJcoVtXFpjY93lJwdBV5VSvyx6xREi5JgUXNficqDWqyYIsnQwV2dXarnPp1asG4+xOLI1RIiQI1JwXIz2wwLTj11AVpdStzRfGtRE9X2KzvPYGrYUYSyMPBQRIoRMCtuZWdGNucZnTFxcRuLpfGtUkvjNwHIPMRyMYd2RSxtHhAgnFSm4Rr21nknWFsO6PZ8nmUtijwmckjpmYs2JiCFChN5hZKIydGOu8dgPthRh3JTvk6uEjZuLMG5SdEvqWDfmmmZqiqPXHiHCACWFfdSMbcVek7IhKLplAuYdQ8lw57TBWiPI9JSNYQLGHZHxMUKEAUgK+7GXHyME2oowFw61yTSRDQeKMBcqtLksON31nkSIEKE/koLfij/U9XG/XSTfvCZ9QblgRJKRd4PMFRgJ+nIh5tLIqzJsMRKYChQAO4F9g0oKSeK1wMOeQ3npZegv/F4JYOFQiXxspOpbgtzSkyi0ZRR6w2Qa2qM5NKwwGfiYSwgp1AMbB019UHSJd0UdDoQAUEbiaUFWB7Uzn7Gba0cDNx/P6DLlMObV0RwadtL7LB8hAFQBEweFFBqpvCuVy6DozqEkYmeCUuqWKrozNakaiS/I92duY/doQczgEWRPiObRsMJoPG50H8464aSwj5qxYMz3rERLh2Ov+9q1yGl3Pks4r72naEvQbyayMZpHwwpHevmt44STQivd8z0Ri4nhmmnotivhympjWumen+fypJqYSxQ95Pvpu1NJvBHNo2FHClsDjh8Cdpwo/QU4mtewNkUKBua8E5nteKLhZleudtQkDhZhzMl3S/5OKk/rwLjahlExrA1RdOawRQwn6/dc9/su4EXgwAklBZ8Lcn0ZiS/l8saui3BKqpBrNlBk50CMoUnij7mdP+RclBEi5JKRALCxZ4vLESbWgzkkgvkKtZYrkWg4xZ8SQL9JwcRamopdsLFnAxEpRIhIIaU6dGIf9TiELZa6119kwdwe4skgo4SNmxup2inIZEGmNFNTHJYKocyK7aBjhoU9WbAnKDoazA8MeN/EajyHhuTgqU6zxtscvhDsqWCPAaNTkVaBN0up2yqgubv3ZdOVrvOASTZigrwnyOtlbNjaxzMXCe2X2GiZwhjQToVdMfTPJTTsCmmMTgfOAHuMYqqgbYrsKkLeHqJBYhOA8TiBUIVAF46x8gCwF7DTkkIHdm1qohoYoRoXk8RrO7BX9FLMdVAhGHWgc1L9AKzMrr2VF4Hx+SSHLhfHveRKQwIoNmBjkKR6D9jrTPS/MhnUTcS/qXBrT+JhXzmJyzN9tkaqrhD4nM2hyzlqZDbcftDU+9rbhD4+DnPNfqc/lvfsL/12KfU/8F97F1dNaqfjhZ7PpxvLqf+MMiuW5NDtArfbdJ+dWhYk1QqURuJJgX/zG7cdAmu72+bQXHdwH30SASyEJPGEIN8ppe7V/ryr3cwYfYjC+cCcTuypx34xjvaHoHQ6z9cs6HMjKFh9Ni+9n+NheRVQ4TvWDjyWwbmjgQ8D04BRvfyvC2gB/gzsOY4UpGcVpQ0hEsLNwHI5bhXVLSDPmJibU8bMfdSMPYBUKHZtusKsuamJoL8B5rj9UD1QUnDDkL8FclNm0pCeDvLZbuSWJFX/XUr9A7laoXdw0YRuCpeBXN03SXKaIl/ej34aeCGMFbiJtu8Jcm4f9y0DHm4kvqaMxDIBezvVl3XT9h1BJvVxm7iNPt5E1YpS6tdk8lxNxD/SBvcLnJqh8a0Y5IuddM1rourrpdT/LA/XuBk4QU6xDP5bAJS4n+3A87juUHHLqyXciddWTqIyLAmBnqHSKLrFJLYsE69GkvjNit7lJYdcEUOS+Fup7+Mx4v1N+lIuGNHEyEdArsxCZvlFKdY9QkNXmJKC61Va5QzqMCSrzCUF4F138J3Zz9s8ALE/QvePXLG3H+9C/76c+v/tXWKqnCMYK7LRZBW+Wk7iyTySFCrdz0DxPvBLoN3Yj13tYcNQpITtzKxQWOEbTmvLqb8pUzdnGYmnJ2D2qIcgMKYb4+EcBButT33x9kemaKJoUXaEAKAfT2LcHWaj3uOKMZ3Yj4ZFCAPA2QMgBIC7oOv7/SUEd5R8cwcXTUj/rqovBmNpCKatf95BvDRPJITiLAkBHInpWkBiil0hrl6p2KGswBbmfT1tCLK2jLp7+nsdd8W+qZGqZ1P1EASZ4gYbheYhcTeome1+rwAytqu8y2UjO+m6PXiE6VZFfibQJOgBkDMULgH9JEhRwAl3NlPzRFhGrQ848jVxMu3SLHbyvKJvGrBbYTTodEVqJX2YbTbodFeiTaAdYJQr+gmB0wL+a4B4JrbuV+TnBqQkugsVPtHTxnB04RhrUXgDsCaowUnsrwsSS9Mhe0FfFIxdilqgZ4BcGkSqAgXd6OeBe/KAFD6c5vhhnECoPe73Itf4+KE09obTgfKYz+iWNSm4QUHecuuJgRBCTxOqeUcr1rMpVUIwFjVT80xYk0cwWgZ6bjc6Q5DRAYPmyWnUfy3ATvBcIzO+B4WrBEp958Q6sW8EHsm2TU1UX6zojWn4YJNB7B+m8fL2AJI7tZPu+wU+EuKgfdfA/Bv//XYz46FDFD4E9KYC1ccoWjSVF1o9x57aTuUj3RiP+vsQwIbrg0hhO5dWC9aHgiaPIt8oY9RzwvPdfiJpovozoF89XrqQjym3LBF+Yg0iIRhppLG9wHOuQbHnFHWMi1cT0HfAeYZgFh+7unkw2ye0sXqEDBdi3JvtNSey4YAgPSSDI+j88HrVbDk2Mc1+idqKdXrQcRNWpjMclvPaHgO593idUTcpEkoatKJ3pjn+5miOzA8iBEfef+n9MtoXKvpmWIJYDO4Out+ZvHZoPMbd6uizQae2xujwEwIAjsfGuosAt5ogZcHv2XoP5FGFJu9NDFhQTt0zfkJwiVrLqHsc9McBlxyZJDltkKWEIoKznTcHEIKHN3neld68x/YDbQZoaJvAurr+bK/aENZqXkbi6VR2o9MCe3Zu+rh//SFpQk9tjIt6O6+UulcVliv2FwoxZpeSmFlG/afC2PbuXS4bqR6Pks9Q+NUzee1Q721644hJbEVIHVrfW36GqyL+T5q+/dlUNrWmO7ecjY0a7CEZt5Xy4+wRU0k0lVF3fzmJ68C+RmE52P8xjcSf+1445Nmg4zFikwaZFNIlUJ3ep5Dr9N164CfAo8BTwO97qA/Z5jq4fm3vBPtNuHKSsS4Vii3IlO3MrAjDEzEW3bx/wKqH/TYY6hctLazlSeIzYxhPTmXDm8GDOrEyF6Oki+64HJ+Pj6IbymnYlMk1pvHyBsc3n52RUtFX++5D0kxK2ZTBZH1V0eNUndGMG+NbCX2LTMM79OF+3sVVkw5zeBpIiQXnS6D9TEcNMil04yxMfuP7+TgxC5tw4hGCApWSwUTn224tS4PdFPFIMuMx6sJsvWCsUyzPRi8jQvFCTGTDgaTbDerZ6CYTlNCwK0l8Pb6V2a1/8Olu7E83UtViIC8oxssj6a6bTMPeXI4SG6ZLsPL5+35KQQmyJAUDo7XvcWO0SsCYtdH3MyCd1uBnH5Wxd2EnlaM6KbjIduwN54OUKVrWTsfonoFWgaQUY/Dxehq7TLH7OQI0u+SwE/igt4uF2iADc6x61Oiwi7z6V3QLq4KQ3KieiTCAyEt7CRjnAOcFX1OmODEG9q2HMUhStRXkBRP9VQn1r+TA8lQcHAUlW/tH8jRlH5Ju9xmQZWJbdvDzZhDMJfZAYr52UjmqA+MGhRvb4RLBKvC2PPN2q+QJKUzCyaoMwggco2LpMfsV7+KkYr/jlyKMMJ9MUW/ARSLslh9PMnboodOpqs/9s3c0fDAS+1bgh44rq8+BfC5wp4U80Uj8/5qo+ZSGmBKiyCnBk6+/xT91WJbBb6R6bjvGeoV/AaqDVK0hiN8Bf+hNZfJglKteXAvc4WoLBV5SCHHySotnck0fKr3pDYYSx2rbb0ymob2MxIoYOhv4rsvEmUgm0xR7aRPxNbu4alI+9YtgyHAjhCTxxYKuyDS82cVuTWv3yCtsAR7Hqb2wJ8NzCoFLgFtwjZM91IdtXFqTjbFRsZrlaIJN+AlQbgyEd9CGEmx1AKkI6xnd5KYHgAeSVJ8H9pWOvidVBATbeBA/RMd/bmPWZ6fxfEd2k1nbNNAoJqf2730ydjixQiPVc0AX9NLiDkVeAV430LdNJFmAvW0yDe2NzCwH8xdDoJldwBvuZxROVGkxToXo3sbfKTjxHc/EnNVdQzE2+oOAksRrwyzpZmFVSA9x2GoJv08ltGuWUfc28DbwqFJZsAOzysb+qA3XByX5CFxg0z4X+HFWWjw0S7B6Vw78MfP3aZfmT6J71mqhkcT+cnB7pBF4pJT2XwtvHAlWvUZM9C5IQwTtOFGgbx3VwOEcnOSzU9PYHqoMxWo+NpisrFb3Qp+3QZCakF/tXM8AD63ug401xSvt5EYUb+gqoe6lUuqXlaEf5bjckNT97euyvZfhiJFBV7+yH5NINETP1OCrDVUfSlUp92FdKYfmllH383SE4CxI3ecPg27YB7wC/BQn5DyovdNivgHZr7h/P4rZ0NxI1ZZj+zbqvGZqVoURwOSqDtM9Uklo7k6/KzXz82bF3uHwed1QAnaJoiWClChSX07dt3sjCOCHjcRvFLjA92vWwWQFxBKddHcdb0CTy5uoOr+U+rcymESXSwjPkj8wyoO8FCb2t3ojA0/fXZ+nDRuHU0hlnOcjOCHOvaHZtUHM8HeU4dXLBSNr3VqQHhF5ndiLw1Edupf0fJndK8NbxY+1uz92imY6C7qwnwL734G7xamlcLGgn32HKyYP8HHMbNtzNi8dFggKHDMUvhYU7efFu1w2UmAxwwgGOiLo+FRK+zTINVJ1nTjGuHzELJzdpC7FSbeejLM/xIDDrw1fgFHWocP+cGSgNtsNV5JU35+SPtypuzbkmgpH292fgKuzeekwaEPATyOPcOQHvaXWbiP+V8dLCSAZei36Jjrrh2l+qRTGf38b8cCU5iZqzuik63v0URRl6EF2Bbd3+6zex168VpCBbkhcBHwUWIDj+ruckGODSD9eZrn2g3Q4heC4GjvmRvMlcPXHMIyDJrF7U+XT3YG+uJFqHUhcf5Lq+1Pl0lxdt63IlxyVHeHEvZGI6/sfcGWsAr00YHKXdsMvk8R/K/C8YuwEu1PgTBtqLfQaCTB6CfL7MNpVysbXklT9HOSGgHvUWLAuSfw3YL8lxPYq1liQGYo9S5CRDDMUYW1ux+gW36RUWNFI/F/LaH8mpUYos2LbOVxlY98OXDNgXoaP03OrtwvdyfjrEJu2GUeKMY/TIuGvcbIlt+KEQnfieCDOxIlTCJKeWmJux6yTY6XOa7KxK8DRuPnlXhFU0CVJ4tWFGMszsTFsZ2ZFN+YKfCXgTcwvFfNyiMZAuSalayr0205RTt1vk1T/Dsd4GDQwZivMTgWNHUuSCLSCt45DngqrZeMxv9GK/eF09QCA68G43qkcOexCEnpgMg17k1T92m8bECdn4JtNjPp6I/G/gGqSQ5OCA5p0P8j4DG95JsF7P5a4xNAWUtMO48QaXZrm99MIrlmRDq8YDoseK9YaVvahk+wja32Hazux1zdRtcS3QgNOEFEj1XOTxFdYmGvl+ACoxWFvUKPY8WOrycCK1o5H/lEdv3AWz0GXCV8JMzTcSTm37wR2E4ECCr+TPk0bQ+Asp7J3YITjOgmo0dCH6jCQ3waC10jrceoX6oHdBjheA++mq9uZGUowTxl196ivGrAzAWQ+8HCS+FuNxOuTxNckib+1Hzsh6ArcUvBelQFn2/hQd7/ezswK72a6A/WSTGTDgUJitzGAvSfc9u0SZEEJdS+FPRHKaHhHKbhFob/Xfne4kcI5vLjThC+C7unPeYKuKqXky4rY/ThtD8FJGZ1Aaw6a9wfgZZysyf6iGycKciN4ch+8pd0tzEVhPWk5iZUG5jyf8dErvo3BqaKcDokY1u252NfSwlwS1P6B4GxeOlxGYrE6pdbWqrP3X2+wgVcVlhcSu66MuvpcTYZy/rSnnMQCQReBNPRBUNsUWQb2J4ejtODUTtAbQB+n92zBdkV/ZcCtpdQvG0B1pUPuJPW/8z9AzqKgXgOeAF7NUD35wP3vk3gkXf9eks+m6vPlYi9Jt0Lz/J6ehLRYb2CuytV+lr69JNuKMG4Kc8MPx1jVWa50nWdjTBAn777D2XRF9o4l9uokXjw4GBPDrbw8Q5FiQUc7eqm9R7BfL+WVHQC7uXb0IVo3BqyagdWchyKUyoLtFMy0sCeDThLoMjDeB9ldwsFXMotf6BOn4th0bJysxEzeeTb7Pngx1r3/aByjoo2zGUwHTiBTIHEctcQ6gUeVK8FY5FCatYiQ05Jd8f9pdzeeaidoyCwGnSLIZhvrgGBsHo9RF3ba9fHLtOWRhuyVxSRCjWR0S3ttCUnXCxVn8cf38FSwDkIXBwuD+00shgncILJcb6L8PuntGLnGAQawKW0P98wEYqtasRe40kJ12LkLXgLCiagaFLhGzuqUlDCB2Coi+EjBOjvQGuesWBFyi0Et3NIjttdZne2Vx8QrXTIce9zXrgdzLZXkC7ZSXpik8pwM++j6YEnBfi+asznHmLwhBYByGh70eiKaqL5vOPV2E9X3eT0OuaqTmF8keMGIJqruEMavV4zVO7hyQh+SVFzhtqDfiohtjeZsTnEqcEbgaxwsUnDJYKlnxZjn7gk55OEaOucFtXN4kkFlQZL4bU2MXq/IPwkySeCsLjp/mqTmSn+1pz1ccEoj8b9TeDRN8M7WIbr7cr6rCqNwEpnOx4lCDIokO3KiHkh6W1G9E8jEmhP+5q4nDtuZWWFhrvUQwupS6oY1KSSp/AIYX+nlL38BGoHDIKcrWtFHabJvlpH4UTSPQ8XFQCYlBrYRnOR2YiQFAHfCHLVQd2OuaaameCj2ejM1xd2Y3mi09cOdEJx32PEoTonvdDgDuAKoBZ3RGyEo+mYpJU9Ec3jQsG1Q1YcUxmPcm9rgVWBMB3YuNnfNKfZRM7YD++FUeThFt4wPYdeqoQDhjSMxOv4Wp9pvFmoIzTDi84O8PdrJjD2k2aPhhJPCRDYcKMJcmKpwLDC9FXvISAzN1BS3Yq9J5VA4QUrmwpPF2wAwlU2tBqNvA37EgIxV+kvBvrmcP+2J5uagEcKvOIGGxoxS4/z6uMLBGNYd+WxjcLMs13gLyA51u0j2Nobq80A/p3CtOFFu6YhgP8jvYhir0+1uFSFnNgXFyY/Yi2PvaSR4d6fBJQXPJHvMt0354rCTlMIZ/PGb8SRiKbTFsG4/mQmhpzpQWbADudBGzrWRCYIlirQL5l5gaynnNEWqwsmLfiXRO/kR1sPe3AUng6x+Wb40qImqJW4WJikbQhHmwsiVFiFCDkgBHMPdfuwVeEqYKdoiyLJchET3QzqoVXSJr9jo+vEY955MNoQIEU44KRxbkXvGMbioMzAfylVmYxDcbMdF+NKvT4Y4hAgR8ooUPKvzfYL4KxevM7EeyqUO7xo/l/jJQNGdgiwdTKklQoSTlhRScKs13+UzQqJoiwHrFKkLY5K62Y21ilb79yRw3aYPngy5DBEi5D0ppGwNrXTPB2OBnxy8EoSgm22MFgO7BWAc5havzr+PmrEfuJu+2BhTDOwp6uz1WBt0QYcM7JUTiK2KbAcRIuQRKaTQTE3xEXS+jV0boFaEBkV3GhjrRiCrIs9ChAh5TAp+gujArhVnlQ9jX8L1CnVFGOsiIogQYQiSgl+92O+UYKtwbuyUYXNVgAqBUxTaxNncApCW1GavJ6pEW4QIEeD/AQEf9kHZmaCkAAAAAElFTkSuQmCC"},1184:(e,s,i)=>{i.d(s,{R:()=>t,x:()=>a});var o=i(4041);const n={},r=o.createContext(n);function t(e){const s=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:t(e.components),o.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e95c892.bc6cc31c.js b/assets/js/5e95c892.bc6cc31c.js new file mode 100644 index 000000000..12e08fe69 --- /dev/null +++ b/assets/js/5e95c892.bc6cc31c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sigma_website=self.webpackChunk_sigma_website||[]).push([[647],{3531:(e,s,r)=>{r.r(s),r.d(s,{default:()=>l});r(4041);var a=r(4357),t=r(145),u=r(7473),c=r(8150),i=r(1794),n=r(1085);function l(e){return(0,n.jsx)(t.e3,{className:(0,a.A)(u.G.wrapper.docsPages),children:(0,n.jsx)(i.A,{children:(0,c.v)(e.route.routes)})})}}}]); \ No newline at end of file diff --git a/assets/js/8070e160.cb26c3ea.js b/assets/js/8070e160.cb26c3ea.js new file mode 100644 index 000000000..39aeff47f --- /dev/null +++ b/assets/js/8070e160.cb26c3ea.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sigma_website=self.webpackChunk_sigma_website||[]).push([[822],{3675:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var a=s(1085),t=s(1184);const i={title:"Quickstart Guide",sidebar_position:2},r="Quickstart Guide",c={id:"quickstart",title:"Quickstart Guide",description:"Installation",source:"@site/docs/quickstart.md",sourceDirName:".",slug:"/quickstart",permalink:"/docs/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/jacomyal/sigma.js/tree/main/packages/website/docs/quickstart.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{title:"Quickstart Guide",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/"},next:{title:"Resources",permalink:"/docs/resources"}},o={},l=[{value:"Installation",id:"installation",level:2},{value:"Using CDN",id:"using-cdn",level:3},{value:"Using Package Managers",id:"using-package-managers",level:3},{value:"Quick Example",id:"quick-example",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"quickstart-guide",children:"Quickstart Guide"}),"\n",(0,a.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,a.jsx)(n.h3,{id:"using-cdn",children:"Using CDN"}),"\n",(0,a.jsx)(n.p,{children:"To quickly integrate sigma.js and graphology into your project, you can use CDN links. Add the following lines to the head section of your HTML:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-html",children:'<script src="https://cdnjs.cloudflare.com/ajax/libs/sigma.js/[VERSION]/sigma.min.js"><\/script>\n<script src="https://cdnjs.cloudflare.com/ajax/libs/graphology/[VERSION]/graphology.umd.min.js"><\/script>\n'})}),"\n",(0,a.jsxs)(n.p,{children:["Replace ",(0,a.jsx)(n.code,{children:"[VERSION]"})," with the desired version number."]}),"\n",(0,a.jsx)(n.h3,{id:"using-package-managers",children:"Using Package Managers"}),"\n",(0,a.jsx)(n.p,{children:"For npm or yarn:"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:"npm"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"npm install sigma graphology\n"})}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:"yarn"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"yarn add sigma graphology\n"})}),"\n",(0,a.jsx)(n.h2,{id:"quick-example",children:"Quick Example"}),"\n",(0,a.jsx)(n.p,{children:"Here's a basic example using CDNs to create a graph with minimal data and render it using sigma.js:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-html",children:'<!doctype html>\n<html lang="en">\n <head>\n <meta charset="UTF-8" />\n <title>Quick Sigma.js Example \n + + + + + + +