Add template.sources config

Author: ShukantPal

packages/webdoc-cli/README.md

@@ -138,6 +138,8 @@ The `template` object is used by the site template.
     item defines a name and URI.
 * `template.routes`: This can be used to override specific routes generated by the template. For example, you can move the
   `tutorials` to be outputted at "/faq" instead of "/tutorials", if desired.
+* `template.sources`: (enabled by default) This will output the source code of the project as well and link symbols to their
+    locations in the code.
 * `template.title`: This is the title shown in the browser tabs (defaults to `template.applicationName`). You should use this
     if you have HTML in the application name.
 * `template.meta`: (optional) This can be used to define the `<meta>` key-value tags. The `{{url}}` variable can be used

packages/webdoc-cli/src/config.js

@@ -48,6 +48,7 @@ type ConfigSchema = {
     routes: {
       tutorials: string,
     },
+    sources: boolean,
     stylesheets: Array<string>,
     siteDomain?: string,
     siteRoot: string,
@@ -104,6 +105,7 @@ const defaultConfig: ConfigSchema = {
       tutorials: "tutorials",
     },
     siteRoot: "",
+    sources: true,
     stylesheets: [],
     mainPage: {
       title: "Main Page",

packages/webdoc-default-template/publish.js

@@ -270,7 +270,7 @@ async function outSource(
   source /*: ?$ReadOnlyArray<SourceFile> */,
   mainThread /*:: ?: boolean */,
 )/*: Promise<void> */ {
-  if (!source) return;
+  if (!source || !config.template.sources) return;
 
   function renderSource(file /*: SourceFile */, raw /*: string */) {
     const pkgName = file.package.name || "";
@@ -467,6 +467,7 @@ async function outReference(
         appBar: {current: "reference"},
         document: doc,
         explorerData,
+        sources: config.template.sources,
         title: doc.name,
         require,
         env: config,

packages/webdoc-default-template/tmpl/components/member/index.tmpl

@@ -2,7 +2,7 @@
 /**
  * Object member render component.
  */
-const { doc, require } = obj;
+const { doc, require, sources } = obj;
 const linkSvg = this.getPlugin("linker").getResourceURI("icons/link.svg");
 const pkgName = doc.loc && doc.loc.file && doc.loc.file.package && doc.loc.file.package.name || "";
 const pkgRelativePath = (doc.loc && doc.loc.file && doc.loc.file.package
@@ -33,7 +33,7 @@ const modifiers = [
           (deprecated)
         <?js } ?>
       </span>
-      <?js if (source) { ?>
+      <?js if (source && sources) { ?>
         <span class="tag--source">
             <a href="<?js= source + sourceLinkFragment ?>">
               <?js= sourceName + sourceStart ?>

packages/webdoc-default-template/tmpl/components/members.tmpl

@@ -39,6 +39,7 @@ const
       return true;
     });
 const require = obj.require;
+const sources = obj.sources;
 
 if (categoryMembers.length === 0) {
   return;
@@ -49,6 +50,6 @@ if (categoryMembers.length === 0) {
   <hr />
 
   <?js categoryMembers.forEach((member) => { ?>
-    <?js= this.partial("components/member/index.tmpl", { doc: member, require }) ?>
+    <?js= this.partial("components/member/index.tmpl", { doc: member, require, sources }) ?>
   <?js }) ?>
 </div>

packages/webdoc-default-template/tmpl/document.tmpl

@@ -4,6 +4,7 @@
    */
   const doc = obj.document;
   const require = obj.require;
+  const sources = obj.sources;
 
   const titleMods = [
     doc.deprecated ? "document__title_deprecated" : ""
@@ -50,6 +51,7 @@
           type: "constructor",
         },
         require,
+        sources,
       }) ?>
     <?js } ?>
 
@@ -63,6 +65,7 @@
         type: "PropertyDoc",
       },
       require,
+      sources,
     }) ?>
     <?js= this.partial("components/members.tmpl", {
       title: "Protected Properties",
@@ -72,6 +75,7 @@
         type: "PropertyDoc"
       },
       require,
+      sources,
     }) ?>
     <?js= this.partial("components/members.tmpl", {
       title: "Public Methods",
@@ -81,6 +85,7 @@
         type: ["MethodDoc", "FunctionDoc"],
       },
       require,
+      sources,
     }) ?>
     <?js= this.partial("components/members.tmpl", {
       title: "Protected Methods",
@@ -90,6 +95,7 @@
         type: ["MethodDoc", "FunctionDoc"]
       },
       require,
+      sources,
     }) ?>
     <?js= this.partial("components/members.tmpl", {
       title: "Events",
@@ -98,6 +104,7 @@
         type: "EventDoc"
       },
       require,
+      sources,
     }) ?>
   </div>
   <div class="footer-gap" style="min-height: 48px;"></div>