Add link to source for block reference (#37750)

WordPress · Jan 6, 2022 · fd9aef8 · fd9aef8
1 parent 7a8d9fa
commit fd9aef8
Show file tree

Hide file tree

Showing 2 changed files with 105 additions and 90 deletions.
diff --git a/bin/api-docs/gen-block-lib-list.js b/bin/api-docs/gen-block-lib-list.js
@@ -122,6 +122,20 @@ function augmentSupports( supports ) {
  return supports;
 }
 
+/**
+ * Returns URL to the block directory source.
+ *
+ * @param {string} filename
+ *
+ * @return {string} URL
+ */
+function getSourceFromFile( filename ) {
+ const pkgdir =
+ 'https://github.com/WordPress/gutenberg/tree/trunk/packages/block-library/src/';
+ const blockdir = path.basename( path.dirname( filename ) );
+ return pkgdir + blockdir;
+}
+
 /**
  * Reads block.json file and returns markdown formatted entry.
  *
@@ -132,14 +146,15 @@ function augmentSupports( supports ) {
 function readBlockJSON( filename ) {
  const blockjson = require( filename );
 
+ const sourcefile = getSourceFromFile( filename );
  const supportsAugmented = augmentSupports( blockjson.supports );
  const supportsList = processObjWithInnerKeys( supportsAugmented );
  const attributes = getTruthyKeys( blockjson.attributes );
 
  return `
 ## ${ blockjson.title }
 
-${ blockjson.description }
+${ blockjson.description } ([Source](${ sourcefile }))
 
 - **Name:** ${ blockjson.name }
 - **Category:** ${ blockjson.category }