mirror of
https://github.com/excalidraw/excalidraw.git
synced 2024-11-10 11:35:52 +01:00
f23cdc47ee
* docs: migrating existing docs to docosaraus :) * log broken links * lint :p * fix * divide the doc into diff categories * fix * order sidebars and more * fix lint * point to installation * making docs better :) * fix * renaming git * renaming git * fix links * fix * update readme * fix * resolve duplicate url and make /docs as base url * fix * move main docs as well * making docs better * support mdx * update og * fix title * upgrade docusarus to stable version * use draculla theme * fix * make entire sidebar collapsable * live editor for footer wohoo * render excalidraw only on client to fix the prod build * migrate MainMenu to live editor too :) * lint :p * cleanup integration and use live editor and tabs * fix * Add welcome screen doc * Live Collaboration comp docs * Add collaborator example * Add example * add more * remove isCollaborating * Rewrite ref and move to sidebar * change color of links inside pre * add initial data * fix lint * Add styling * fix lint * Add example for customizing styles * fix lint * fix * fix lint * Add link to livecollabtrigger * fix * rewrite UIOptions to sidebar * move initialdata to sidebar * move render props to sidebar and rewrite renderTopRightUI and renderCustomStats * rewrite renderSidebar * update og * update url for testing * fix url * update readme * fix style * tweaks * Add highlight comp to highlight text * Add bash syntax highlight * fix * tweaks * fix * rewrite export utilities * fix restore * rewrite utils * move constants to sidebar * update readme * add copyright * fix links style * Add linkedin * tweaks * rename package to @excalidraw/excalidraw * enable algolia with dummy creds * tweaks to integration doc * tweak WelcomeScreen docs to reflect upcoming API changes * tweak components intro * tweak nomenclature * fix admonition * rename `components` sidebar item and change order of components list * uncollapse package section in sidebar * show level 4 haeadings in TOC * remove algolia * remove unused assets * capitalize C * tweak * rename components to App * rename components -> children-components in the routes * move notable used tools to intro * update MainMenu docs with `onSelect` preventDefault behavior * change sidebar label for children components * use code * tweak README & docs intro * tweak package development doc * make scrollbar gutter stable * tweak api intro * add admonition for export utils * use next * wip * wip * make excalidraw examples use current color theme & prefer system * fix welcomescreen docs * use latest temp release * fix component order * revert wip changes * use next * tweak * increase height to fix welcome screen hint * tweak editor height * update excal version * wrap Excal with forwardRef to fix refs * migrate contributing.md * fix broken links --------- Co-authored-by: dwelle <luzar.david@gmail.com>
138 lines
3.5 KiB
JavaScript
138 lines
3.5 KiB
JavaScript
// @ts-check
|
|
// Note: type annotations allow type checking and IDEs autocompletion
|
|
|
|
/** @type {import('@docusaurus/types').Config} */
|
|
const config = {
|
|
title: "Excalidraw developer docs",
|
|
tagline:
|
|
"For Excalidraw contributors or those integrating the Excalidraw editor",
|
|
url: "https://docs.excalidraw.com",
|
|
baseUrl: "/",
|
|
onBrokenLinks: "throw",
|
|
onBrokenMarkdownLinks: "warn",
|
|
favicon: "img/favicon.ico",
|
|
organizationName: "Excalidraw", // Usually your GitHub org/user name.
|
|
projectName: "excalidraw", // Usually your repo name.
|
|
|
|
// Even if you don't use internalization, you can use this field to set useful
|
|
// metadata like html lang. For example, if your site is Chinese, you may want
|
|
// to replace "en" with "zh-Hans".
|
|
i18n: {
|
|
defaultLocale: "en",
|
|
locales: ["en"],
|
|
},
|
|
|
|
presets: [
|
|
[
|
|
"classic",
|
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
|
({
|
|
docs: {
|
|
sidebarPath: require.resolve("./sidebars.js"),
|
|
// Please change this to your repo.
|
|
editUrl: "https://github.com/excalidraw/docs/tree/master/",
|
|
},
|
|
theme: {
|
|
customCss: [
|
|
require.resolve("./src/css/custom.scss"),
|
|
require.resolve("../src/packages/excalidraw/example/App.scss"),
|
|
],
|
|
},
|
|
}),
|
|
],
|
|
],
|
|
|
|
themeConfig:
|
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
|
({
|
|
colorMode: {
|
|
respectPrefersColorScheme: true,
|
|
},
|
|
navbar: {
|
|
title: "Excalidraw",
|
|
logo: {
|
|
alt: "Excalidraw Logo",
|
|
src: "img/logo.svg",
|
|
},
|
|
items: [
|
|
{
|
|
to: "/docs",
|
|
position: "left",
|
|
label: "Docs",
|
|
},
|
|
{
|
|
to: "https://blog.excalidraw.com",
|
|
label: "Blog",
|
|
position: "left",
|
|
},
|
|
{
|
|
to: "https://github.com/excalidraw/excalidraw",
|
|
label: "GitHub",
|
|
position: "right",
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: "dark",
|
|
links: [
|
|
{
|
|
title: "Docs",
|
|
items: [
|
|
{
|
|
label: "Get Started",
|
|
to: "/docs",
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: "Community",
|
|
items: [
|
|
{
|
|
label: "Discord",
|
|
href: "https://discord.gg/UexuTaE",
|
|
},
|
|
{
|
|
label: "Twitter",
|
|
href: "https://twitter.com/excalidraw",
|
|
},
|
|
{
|
|
label: "Linkedin",
|
|
href: "https://www.linkedin.com/company/excalidraw",
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: "More",
|
|
items: [
|
|
{
|
|
label: "Blog",
|
|
to: "https://blog.excalidraw.com",
|
|
},
|
|
{
|
|
label: "GitHub",
|
|
to: "https://github.com/excalidraw/excalidraw",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
copyright: `Copyright © 2023 Excalidraw community. Built with Docusaurus ❤️`,
|
|
},
|
|
prism: {
|
|
theme: require("prism-react-renderer/themes/dracula"),
|
|
},
|
|
image: "img/og-image.png",
|
|
docs: {
|
|
sidebar: {
|
|
hideable: true,
|
|
},
|
|
},
|
|
tableOfContents: {
|
|
maxHeadingLevel: 4,
|
|
},
|
|
}),
|
|
themes: ["@docusaurus/theme-live-codeblock"],
|
|
plugins: ["docusaurus-plugin-sass"],
|
|
};
|
|
|
|
module.exports = config;
|