Merge pull request #1 from iasql/flatten

Simplify naming and nesting
alantech · Dec 23, 2022 · 6cc9ce5 · 6cc9ce5
2 parents ebff7be + 3a14747
commit 6cc9ce5
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -3,3 +3,7 @@
 A plugin to automatically generate SQL documentation for docusaurus
 
 Forked from: https://github.com/tgreyuk/typedoc-plugin-markdown
+
+## Local testing
+
+Use "npm link" to pick up the live changes in the Docusaurus instance used
diff --git a/dist/lib/theme.js b/dist/lib/theme.js
@@ -274,7 +274,7 @@ class MarkdownTheme extends typedoc_1.Theme {
             page.model instanceof typedoc_1.DeclarationReflection ? page.model : undefined;
     }
     get globalsFile() {
-        return "sql_reference.md";
+        return "sql.md";
     }
 }
 exports.MarkdownTheme = MarkdownTheme;

diff --git a/dist/options.js b/dist/options.js
@@ -4,13 +4,13 @@ exports.getPluginOptions = void 0;
 const DEFAULT_PLUGIN_OPTIONS = {
     id: "default",
     docsRoot: "docs",
-    out: "sql",
+    out: "reference",
     cleanOutputDir: true,
     sidebar: {
         fullNames: false,
-        categoryLabel: "SQL reference",
+        categoryLabel: "Reference",
         indexLabel: undefined,
-        readmeLabel: "Introduction",
+        readmeLabel: "SQL",
         position: null,
         autoConfiguration: true,
         usedSidebar: "docs",
@@ -19,7 +19,7 @@ const DEFAULT_PLUGIN_OPTIONS = {
     hideBreadcrumbs: true,
     hidePageTitle: true,
     hideMembersSymbol: false,
-    entryDocument: "sql_reference.md",
+    entryDocument: "sql.md",
     plugin: ["none"],
     watch: false,
     includeExtension: true,

diff --git a/dist/theme.js b/dist/theme.js
@@ -173,7 +173,7 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
         });
     }
     get globalsFile() {
-        return "sql_reference.md";
+        return "sql.md";
     }
 }
 __decorate([

diff --git a/src/lib/theme.ts b/src/lib/theme.ts
@@ -374,6 +374,6 @@ export class MarkdownTheme extends Theme {
   }
 
   get globalsFile() {
-    return "sql_reference.md";
+    return "sql.md";
   }
 }
diff --git a/src/options.ts b/src/options.ts
@@ -1,15 +1,15 @@
 import { PluginOptions } from "./types";
 
 const DEFAULT_PLUGIN_OPTIONS: PluginOptions = {
-  id: "default",
+  id: "reference",
   docsRoot: "docs",
-  out: "sql",
+  out: "reference",
   cleanOutputDir: true,
   sidebar: {
     fullNames: false,
-    categoryLabel: "SQL reference",
+    categoryLabel: "Reference",
     indexLabel: undefined,
-    readmeLabel: "Introduction",
+    readmeLabel: "SQL",
     position: null,
     autoConfiguration: true,
     usedSidebar: "docs",
@@ -18,7 +18,7 @@ const DEFAULT_PLUGIN_OPTIONS: PluginOptions = {
   hideBreadcrumbs: true,
   hidePageTitle: true,
   hideMembersSymbol: false,
-  entryDocument: "sql_reference.md",
+  entryDocument: "sql.md",
   plugin: ["none"],
   watch: false,
   includeExtension: true,

diff --git a/src/theme.ts b/src/theme.ts
@@ -206,7 +206,7 @@ export class DocusaurusTheme extends MarkdownTheme {
   }
 
   get globalsFile() {
-    return "sql_reference.md";
+    return "sql.md";
   }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -206,7 +206,7 @@ export class DocusaurusTheme extends MarkdownTheme { @@
       }
       get globalsFile() {
-        return "sql_reference.md";
+        return "sql.md";
       }
     }
@@ Expand Down @@