mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Updated folder structure of core docs (#4415)
* [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Manual fixes to core doc file links * [ADF-4152] Further automatic + manual link tidying
This commit is contained in:
committed by
Eugenio Romano
parent
285e56e9fb
commit
5fc05da7aa
@@ -24,7 +24,8 @@
|
||||
"fileChecker"
|
||||
],
|
||||
"dev": [
|
||||
"typeLinker"
|
||||
"sourceLinker",
|
||||
"gqIndex"
|
||||
]
|
||||
},
|
||||
"statusIcons": {
|
||||
|
5
tools/doc/templates/gqIndex.ejs
vendored
5
tools/doc/templates/gqIndex.ejs
vendored
@@ -19,7 +19,10 @@
|
||||
<% }
|
||||
|
||||
sectionDocs.forEach(document => { -%>
|
||||
| [<%= document['title'] %>](<%= relDocPath(document['id']) %>) | <%= document['paragraph']['plaintext'] %> | [Source](<%= relSrcPath(document['heading']['link']['url']) %>) |
|
||||
| [<%= document['title'] %>](<%= relDocPath(document['id']) %>) -%>
|
||||
<% if (document['status'] && document['status'] !== 'Active') { -%>
|
||||
![<%= document['status'] %>](docassets/images/<%= document['status'] %>Icon.png) <% } -%>
|
||||
| <%= document['paragraph']['plaintext'] %> | [Source](<%= relSrcPath(document['heading']['link']['url']) %>) |
|
||||
<% });
|
||||
}
|
||||
-%>
|
||||
|
@@ -9,14 +9,14 @@ var replaceZone = require("mdast-zone");
|
||||
var graphql_1 = require("graphql");
|
||||
var MQ = require("../mqDefs");
|
||||
var libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/;
|
||||
var libNamesList = ['process-services'];
|
||||
var libNamesList = ['core', 'process-services'];
|
||||
var query = "\n query libIndex($libName: String) {\n documents(idFilter: $libName) {\n title: metadata(key: \"Title\")\n status: metadata(key: \"Status\")\n id\n classType: folder(depth: 2)\n heading {\n link {\n url\n }\n }\n paragraph {\n plaintext\n }\n }\n }\n";
|
||||
function processDocs(mdCache, aggData, _errorMessages) {
|
||||
var docset = new GQDocset(mdCache);
|
||||
var templateFilePath = path.resolve(__dirname, '..', 'templates', 'gqIndex.ejs');
|
||||
var templateSource = fs.readFileSync(templateFilePath, 'utf8');
|
||||
var template = ejs.compile(templateSource);
|
||||
var indexFilePath = path.resolve(aggData['rootFolder'], 'README.md');
|
||||
var indexFilePath = path.resolve(aggData['rootFolder'], 'docs', 'README.md');
|
||||
var indexFileText = fs.readFileSync(indexFilePath, 'utf8');
|
||||
var indexMD = remark()
|
||||
.use(frontMatter, ["yaml"])
|
||||
|
@@ -12,7 +12,7 @@ import { graphql, buildSchema } from 'graphql';
|
||||
import * as MQ from '../mqDefs';
|
||||
|
||||
let libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/;
|
||||
let libNamesList = ['process-services'];
|
||||
let libNamesList = ['core', 'process-services'];
|
||||
|
||||
|
||||
let query = `
|
||||
|
@@ -3,7 +3,7 @@ items:
|
||||
name: <%= name %>
|
||||
fullName: <%= name %>
|
||||
source:
|
||||
path: <%= sources[0].fileName %>
|
||||
path: <%= 'lib/' + sources[0].fileName %>
|
||||
startLine: <%= sources[0].line %>
|
||||
children:
|
||||
<%_ if (typeof children !== "undefined") { -%>
|
||||
|
Reference in New Issue
Block a user