Skip to content

Free, simple, and intuitive online database diagram editor and SQL generator.

Add documentation menu and generate documentation markdown

Luis Carlosf71f41d11cf3
diff --git a/src/components/EditorHeader/ControlPanel.jsx b/src/components/EditorHeader/ControlPanel.jsx
index 86171dfd..d2ad401b 100644
--- a/src/components/EditorHeader/ControlPanel.jsx
+++ b/src/components/EditorHeader/ControlPanel.jsx
@@ -70,6 +70,7 @@ import { exportSQL } from "../../utils/exportSQL";
import { databases } from "../../data/databases";
import { jsonToMermaid } from "../../utils/exportAs/mermaid";
import { isRtl } from "../../i18n/utils/rtl";
+import { jsonToDocumentation } from "../../utils/exportAs/documentation";
export default function ControlPanel({
diagramId,
@@ -1064,6 +1065,29 @@ export default function ControlPanel({
],
function: () => {},
},
+ Documentation: {
+ children: [
+ {
+ Markdown: () => {
+ setModal(MODAL.CODE);
+ const result = jsonToDocumentation({
+ tables: tables,
+ relationships: relationships,
+ notes: notes,
+ subjectAreas: areas,
+ database: database,
+ title: title,
+ });
+ setExportData((prev) => ({
+ ...prev,
+ data: result,
+ extension: "md",
+ }));
+ }
+ }
+ ],
+ function: () => {},
+ },
exit: {
function: () => {
save();
diff --git a/src/utils/exportAs/documentation.js b/src/utils/exportAs/documentation.js
new file mode 100644
index 00000000..2ec7bd48
--- /dev/null
+++ b/src/utils/exportAs/documentation.js
@@ -0,0 +1,49 @@
+import { dbToTypes } from "../../data/datatypes";
+import { jsonToMermaid } from "./mermaid";
+
+export function jsonToDocumentation(obj) {
+
+ const documentationSummary = obj.tables
+ .map((table) => {
+ return `\t- [${table.name}](#${table.name})\n`;
+ }).join("");
+
+ const documentationEntities = obj.tables
+ .map((table) => {
+ const fields = table.fields
+ .map((field) => {
+ const fieldType =
+ field.type +
+ ((dbToTypes[obj.database][field.type].isSized ||
+ dbToTypes[obj.database][field.type].hasPrecision) &&
+ field.size &&
+ field.size !== ""
+ ? "(" + field.size + ")"
+ : "");
+ return `| **${field.name}** | ${fieldType} | ${field.primary ? "🔑 PK, " : ""}` +
+ `${field.nullable ? "null " : "not null "}${field.unique ? ", unique" : ""}${field.increment?", autoincrement":""}` +
+ `${field.default ? `, default: ${field.default}` : ""} | |${field.comment ? field.comment : ""} |`;
+
+ }).join("\n");
+ return `### ${table.name}\n${table.comment ? table.comment : ""}\n` +
+ `| Name | Type | Settings | References | Note |\n` +
+ `|-------------|---------------|-------------------------------|-------------------------------|--------------------------------|\n` +
+ `${fields}\n\n`;
+ }).join("");
+
+ const documentationRelationships = obj.relationships?.length
+ ? obj.relationships
+ .map((r) => {
+ console.log(r);
+ const startTable = obj.tables[r.startTableId].name;
+ const endTable = obj.tables[r.endTableId].name;
+ return `- **${startTable} to ${endTable}**: ${r.cardinality} (${r.comment ? r.comment : ""})\n`;
+ }).join("") : "";
+
+ return `# ${obj.title} Database Documentation\n## Summary\n- [Introduction](#introduction)\n- [Database Type](#database-type)\n`+
+ `- [Table Structure](#table-structure)\n${documentationSummary}\n- [Relationships](#relationships)\n- [Database Diagram](#database-Diagram)\n`+
+ `## Introduction\n${obj.notes}\n## Database type\n- **Database system:** `+
+ `${obj.database.type}\n## Table structure\n\n${documentationEntities}`+
+ `\n\n## Relationships\n${documentationRelationships}\n\n`+
+ `## Database Diagram\n\`\`\`${jsonToMermaid(obj)}\`\`\``;
+}
\ No newline at end of file