Generate index file

bin/fileProcessor

@@ -2,8 +2,8 @@
 
 const HTML5Outline = require('h5o');
 const { JSDOM } = require('jsdom');
-const fileContentHelper = require('../src/lib/fileContentHelper');
-const treeHelper = require('../src/lib/treeHelper');
+const fileContentHelper = require('../src/helper/fileContentHelper');
+const treeHelper = require('../src/helper/treeHelper');
 
 function getHTML5Outline(fileContent) {
   return HTML5Outline(new JSDOM(fileContent).window.document.body);

bin/generate-index

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+const { docTitle } = require('../constants');
+const chapterHelper = require('../src/helper/chapterHelper');
+const { readFileSync, writeFile } = require('fs');
+const { resolve } = require('path');
+const jsyaml = require('js-yaml');
+const fileProcessor = require('./fileProcessor');
+
+const loadedOutline = jsyaml.safeLoad(readFileSync(`${__dirname}/../config/outline.yaml`, 'utf8'));
+
+const index = `# ${docTitle}\n\n${loadedOutline.map((chapter) => chapterHelper.processChapter(chapter, fileProcessor)).join('\n\n')}`;
+
+writeFile(resolve(__dirname, '../src/pages/docs/index.md'), index, error => error && console.warn(error));

bin/retrieve-documentation

@@ -14,3 +14,4 @@ git clone https://github.com/api-platform/docs.git src/pages/docs
 
 bin/check-outline
 bin/generate-nav
+bin/generate-index

constants.js

@@ -1,3 +1,4 @@
 module.exports = Object.freeze({
   docPagesDirectory: `${__dirname}/src/pages/docs`,
+  docTitle: 'API Platform documentation',
 });

src/data/menu.js

@@ -2,6 +2,7 @@ const menu = [
   {
     text: 'docs',
     rootPath: '/docs',
+    path: '/docs/index',
     submenu: [
       {
         text: 'Distribution',

src/helper/chapterHelper.js

@@ -0,0 +1,25 @@
+const chapterHelper = {
+  processChapterItems(chapter, fileProcessor) {
+    const items = chapter.items.map(file => fileProcessor.processFile(chapter.path, file.id)[0]);
+
+    return items.map((item, index) => this.processChapterItem(chapter.path, item, index)).join('');
+  },
+  processChapterItem(path, item, index) {
+    return `${index + 1}.${(index + 1).toString().length !== 2 ? '  ' : ' '}[${item.title}](${path}/${item.id}.md)\n${this.processItemAnchors(item, path) ? this.processItemAnchors(item, path) : ''}`;
+  },
+  processItemAnchors(item, path, depth = 2) {
+    if (!item.anchors) {
+      return;
+    }
+
+    return item.anchors.map((anchor, index) => this.processItemAnchor(anchor, path, index, depth)).join('');
+  },
+  processItemAnchor(anchor, path, index, depth) {
+    return `${'  '.repeat(depth)}${index + 1}.${(index + 1).toString().length !== 2 ? '  ' : ' '}[${anchor.title}](${path}#${anchor.id})\n${anchor.anchors ? this.processItemAnchors(anchor, path , ++depth) : ''}`;
+  },
+  processChapter(chapter, fileProcessor) {
+    return `## ${chapter.title}\n\n${this.processChapterItems(chapter, fileProcessor)}`;
+  },
+};
+
+module.exports = chapterHelper;