mirror of
https://github.com/excalidraw/excalidraw.git
synced 2025-10-31 19:04:35 +01:00
ddb7585057
* feat: add docs for getCommonBounds * docs: add docs for frames api support * docs: update docs for regenerateIds opts in convertToExcalidrawElements * add docs for ref removal * add docs for lock support and insertOnCanvasDirectly in setActiveTool * fix broken links * update docs for next js support * update docs for Preact * add faq * docs: add `onChange`, `onPointerDown`, `onPointerUp` docs * docs: update `useDevice` docs * update docs for disabling image tool * add docs for withinBounds helpers * fix lint * upgrade excal * add docusaurus2-dotenv for expose env vars * fix env variable and upgrade excal * Update dev-docs/docs/@excalidraw/excalidraw/api/excalidraw-element-skeleton.mdx Co-authored-by: David Luzar <5153846+dwelle@users.noreply.github.com> * update docs Co-authored-by: David Luzar <5153846+dwelle@users.noreply.github.com> * update docs for process.env --------- Co-authored-by: dwelle <5153846+dwelle@users.noreply.github.com>
134 lines
4.0 KiB
JavaScript
134 lines
4.0 KiB
JavaScript
/**
|
|
* Creating a sidebar enables you to:
|
|
- create an ordered group of docs
|
|
- render a sidebar for each doc of that group
|
|
- provide next/previous navigation
|
|
|
|
The sidebars can be generated from the filesystem, or explicitly defined here.
|
|
|
|
Create as many sidebars as you want.
|
|
*/
|
|
|
|
// @ts-check
|
|
|
|
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
|
const sidebars = {
|
|
docs: [
|
|
{
|
|
type: "category",
|
|
label: "Introduction",
|
|
link: {
|
|
type: "doc",
|
|
id: "introduction/get-started",
|
|
},
|
|
items: ["introduction/development", "introduction/contributing"],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Codebase",
|
|
items: ["codebase/json-schema", "codebase/frames"],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "@excalidraw/excalidraw",
|
|
collapsed: false,
|
|
items: [
|
|
"@excalidraw/excalidraw/installation",
|
|
"@excalidraw/excalidraw/integration",
|
|
"@excalidraw/excalidraw/customizing-styles",
|
|
{
|
|
type: "category",
|
|
label: "API",
|
|
link: {
|
|
type: "doc",
|
|
id: "@excalidraw/excalidraw/api/api-intro",
|
|
},
|
|
items: [
|
|
{
|
|
type: "category",
|
|
label: "Props",
|
|
link: {
|
|
type: "doc",
|
|
id: "@excalidraw/excalidraw/api/props/props",
|
|
},
|
|
items: [
|
|
"@excalidraw/excalidraw/api/props/initialdata",
|
|
"@excalidraw/excalidraw/api/props/excalidraw-api",
|
|
"@excalidraw/excalidraw/api/props/render-props",
|
|
"@excalidraw/excalidraw/api/props/ui-options",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Children Components",
|
|
link: {
|
|
type: "doc",
|
|
id: "@excalidraw/excalidraw/api/children-components/children-components-intro",
|
|
},
|
|
items: [
|
|
"@excalidraw/excalidraw/api/children-components/main-menu",
|
|
"@excalidraw/excalidraw/api/children-components/welcome-screen",
|
|
"@excalidraw/excalidraw/api/children-components/sidebar",
|
|
"@excalidraw/excalidraw/api/children-components/footer",
|
|
"@excalidraw/excalidraw/api/children-components/live-collaboration-trigger",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Utils",
|
|
link: {
|
|
type: "doc",
|
|
id: "@excalidraw/excalidraw/api/utils/utils-intro",
|
|
},
|
|
items: [
|
|
"@excalidraw/excalidraw/api/utils/export",
|
|
"@excalidraw/excalidraw/api/utils/restore",
|
|
],
|
|
},
|
|
"@excalidraw/excalidraw/api/constants",
|
|
"@excalidraw/excalidraw/api/excalidraw-element-skeleton",
|
|
],
|
|
},
|
|
"@excalidraw/excalidraw/faq",
|
|
"@excalidraw/excalidraw/development",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "@excalidraw/mermaid-to-excalidraw",
|
|
link: {
|
|
type: "doc",
|
|
id: "@excalidraw/mermaid-to-excalidraw/installation",
|
|
},
|
|
items: [
|
|
"@excalidraw/mermaid-to-excalidraw/api",
|
|
"@excalidraw/mermaid-to-excalidraw/development",
|
|
{
|
|
type: "category",
|
|
label: "Codebase",
|
|
link: {
|
|
type: "doc",
|
|
id: "@excalidraw/mermaid-to-excalidraw/codebase/codebase",
|
|
},
|
|
items: [
|
|
{
|
|
type: "category",
|
|
label: "How Parser works under the hood?",
|
|
link: {
|
|
type: "doc",
|
|
id: "@excalidraw/mermaid-to-excalidraw/codebase/parser/parser",
|
|
},
|
|
items: [
|
|
"@excalidraw/mermaid-to-excalidraw/codebase/parser/flowchart",
|
|
],
|
|
},
|
|
"@excalidraw/mermaid-to-excalidraw/codebase/new-diagram-type",
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
};
|
|
|
|
module.exports = sidebars;
|