docs: inline website theme (golangci#1096)

Inline @Rocketseat theme for Gatsby
because we need a lot of changes.

Fix bad GitHub edit url, next/prev links,
    external links without target="_blank".

Author: jirfag

docs/gatsby-browser.js

@@ -0,0 +1,2 @@
+export { wrapRootElement } from "./src/@rocketseat/gatsby-theme-docs/gatsby/wrapRootElement";
+export { wrapPageElement } from "./src/@rocketseat/gatsby-theme-docs/gatsby/wrapPageElement";

docs/gatsby-config.js

@@ -1,28 +1,73 @@
+const withDefault = require(`./src/@rocketseat/gatsby-theme-docs-core/util/with-default`);
+
 const siteUrl = `https://golangci-lint.run`;
 
+const siteConfig = require(`./src/config/site.js`);
+const { basePath, configPath, docsPath } = withDefault(siteConfig);
+
 module.exports = {
   siteMetadata: {
     siteTitle: `golangci-lint`,
     defaultTitle: ``,
     siteTitleShort: `golangci-lint`,
     siteDescription: `Fast Go linters runner golangci-lint.`,
-    siteUrl: siteUrl,
+    siteUrl,
     siteAuthor: `@golangci`,
     siteImage: `/logo.png`,
     siteLanguage: `en`,
     themeColor: `#7159c1`,
-    basePath: `/`,
+    basePath,
     footer: `© ${new Date().getFullYear()}`,
   },
   plugins: [
     `gatsby-alias-imports`,
+
+    `gatsby-transformer-sharp`,
+    `gatsby-plugin-sharp`,
+    {
+      resolve: `gatsby-source-filesystem`,
+      options: {
+        name: `docs`,
+        path: docsPath,
+      },
+    },
+    {
+      resolve: `gatsby-source-filesystem`,
+      options: {
+        name: `config`,
+        path: configPath,
+      },
+    },
+    {
+      resolve: `gatsby-transformer-yaml`,
+      options: {
+        typeName: `SidebarItems`,
+      },
+    },
     {
-      resolve: `@rocketseat/gatsby-theme-docs`,
+      resolve: `gatsby-plugin-mdx`,
       options: {
-        configPath: `src/config`,
-        docsPath: `src/docs`,
-        githubUrl: `https://github.com/golangci/golangci-lint`,
-        baseDir: `docs`,
+        extensions: [`.mdx`, `.md`],
+        gatsbyRemarkPlugins: [
+          `gatsby-remark-autolink-headers`,
+          `gatsby-remark-external-links`,
+          `gatsby-remark-embedder`,
+          {
+            resolve: `gatsby-remark-images`,
+            options: {
+              maxWidth: 960,
+              withWebp: true,
+              linkImagesToOriginal: false,
+            },
+          },
+          `gatsby-remark-responsive-iframe`,
+          `gatsby-remark-copy-linked-files`,
+        ],
+        plugins: [
+          `gatsby-remark-autolink-headers`,
+          `gatsby-remark-external-links`,
+          `gatsby-remark-images`,
+        ],
       },
     },
     {
@@ -59,13 +104,11 @@ module.exports = {
         },
       },
     },
-    {
-      resolve: `gatsby-transformer-remark`,
-      options: {
-        plugins: [`gatsby-remark-external-links`],
-      },
-    },
     `gatsby-plugin-netlify`,
     `gatsby-plugin-netlify-cache`,
+
+    `gatsby-plugin-catch-links`,
+    `gatsby-plugin-emotion`,
+    `gatsby-plugin-react-helmet`,
   ],
 };

docs/gatsby-node.js

@@ -0,0 +1,252 @@
+const path = require(`path`);
+const { createFilePath } = require(`gatsby-source-filesystem`);
+const fs = require(`fs`);
+
+const {
+  normalizeBasePath,
+  resolveLink,
+} = require(`./src/@rocketseat/gatsby-theme-docs-core/util/url`);
+const withDefault = require(`./src/@rocketseat/gatsby-theme-docs-core/util/with-default`);
+
+exports.createPages = ({ graphql, actions: { createPage }, reporter }) => {
+  reporter.success(`onCreateDocs`);
+
+  const siteConfig = require(`./src/config/site.js`);
+  const { basePath, baseDir, docsPath, githubUrl } = withDefault(siteConfig);
+
+  const docsTemplate = require.resolve(
+    `./src/@rocketseat/gatsby-theme-docs/src/templates/docs-query.js`
+  );
+  const homeTemplate = require.resolve(
+    `./src/@rocketseat/gatsby-theme-docs/src/templates/homepage-query.js`
+  );
+
+  return graphql(
+    `
+      {
+        files: allFile(filter: { extension: { in: ["md", "mdx"] } }) {
+          edges {
+            node {
+              id
+              relativePath
+              childMdx {
+                frontmatter {
+                  next
+                }
+                fields {
+                  slug
+                }
+              }
+            }
+          }
+        }
+        sidebar: allSidebarItems {
+          edges {
+            node {
+              label
+              link
+              items {
+                label
+                link
+              }
+              id
+            }
+          }
+        }
+      }
+    `
+  ).then((result) => {
+    if (result.errors) {
+      reporter.panic(
+        `docs: there was an error loading the docs folder!`,
+        result.errors
+      );
+      return;
+    }
+
+    createPage({
+      path: basePath,
+      component: homeTemplate,
+    });
+
+    // Generate prev/next items based on sidebar.yml file
+    const sidebar = result.data.sidebar.edges;
+    const listOfItems = [];
+
+    sidebar.forEach(({ node: { label, link, items } }) => {
+      if (Array.isArray(items)) {
+        items.forEach((item) => {
+          listOfItems.push({
+            label: item.label,
+            link: resolveLink(item.link, basePath),
+          });
+        });
+      } else {
+        listOfItems.push({
+          label,
+          link: resolveLink(link, basePath),
+        });
+      }
+    });
+
+    // Generate docs pages
+    const docs = result.data.files.edges;
+    docs.forEach((doc) => {
+      const {
+        childMdx: {
+          frontmatter: { next },
+          fields: { slug },
+        },
+        relativePath,
+      } = doc.node;
+
+      const githubEditUrl =
+        githubUrl &&
+        `${githubUrl}/tree/master/${baseDir}/${docsPath}/${relativePath}`;
+
+      const currentPageIndex = listOfItems.findIndex(
+        (page) => page.link === slug
+      );
+
+      const prevItem = listOfItems[currentPageIndex - 1];
+      const nextItem = next
+        ? listOfItems.find((item) => item.link === next)
+        : listOfItems[currentPageIndex + 1];
+
+      createPage({
+        path: slug,
+        component: docsTemplate,
+        context: {
+          slug,
+          prev: prevItem,
+          next: nextItem,
+          githubEditUrl,
+        },
+      });
+    });
+
+    reporter.success(`docs pages created`);
+  });
+};
+
+exports.createSchemaCustomization = ({ actions }) => {
+  actions.createTypes(`
+    type MdxFrontmatter @dontInfer {
+      title: String!
+      description: String
+      image: String
+      disableTableOfContents: Boolean
+      next: String
+    }
+  `);
+
+  actions.createTypes(`
+    type SidebarItems implements Node {
+      label: String!
+      link: String
+      items: [SidebarItemsItems]
+    }
+
+    type SidebarItemsItems {
+      label: String
+      link: String
+    }
+  `);
+};
+
+exports.onPreBootstrap = ({ store, reporter }, themeOptions) => {
+  const { configPath, docsPath } = withDefault(themeOptions);
+  const { program } = store.getState();
+
+  const dirs = [
+    path.join(program.directory, configPath),
+    path.join(program.directory, docsPath),
+  ];
+
+  dirs.forEach((dir) => {
+    if (!fs.existsSync(dir)) {
+      reporter.success(`docs: intialized the ${dir} directory`);
+      fs.mkdirSync(dir);
+    }
+  });
+};
+
+exports.onCreateNode = (
+  { node, actions: { createNodeField }, getNode },
+  themeOptions
+) => {
+  if (node.internal.type !== `Mdx`) {
+    return;
+  }
+
+  const { basePath } = withDefault(themeOptions);
+
+  let value = createFilePath({ node, getNode });
+  if (value === "index") value = "";
+
+  createNodeField({
+    name: `slug`,
+    node,
+    value: normalizeBasePath(basePath, value),
+  });
+
+  createNodeField({
+    name: `id`,
+    node,
+    value: node.id,
+  });
+};
+
+/**
+[
+  {
+    "node": {
+      "label": "Home",
+      "link": "/",
+      "items": null,
+      "id": "a2913be3-af3c-5fc9-967e-a058e86b20a9"
+    }
+  },
+  {
+    "node": {
+      "label": "With dropdown",
+      "link": null,
+      "items": [
+        { "label": "My Example", "link": "/my-example" },
+        { "label": "Teste 2", "link": "/teste-2" }
+      ],
+      "id": "c7d9606c-4bda-5097-a0df-53108e9f4efd"
+    }
+  }
+]
+*/
+
+// Ler todo o array e salvar em uma objeto chave/valor
+/**
+ * {
+ *    '/': {
+ *       prev: null,
+ *       next: {
+ *          label: 'My example',
+ *          link: '/my-example'
+ *       }
+ *    },
+ *    '/my-example': {
+ *       prev: {
+ *          label: 'Home',
+ *          link: '/'
+ *       },
+ *       next: {
+ *          label: 'Teste 2',
+ *          link: '/teste-2'
+ *       }
+ *    },
+ *    '/teste-2': {
+ *       prev: {
+ *          label: 'My example',
+ *          link: '/my-example'
+ *       },
+ *       next: null
+ *    }
+ * }
+ */

docs/gatsby-ssr.js

@@ -0,0 +1,2 @@
+export { wrapRootElement } from "./src/@rocketseat/gatsby-theme-docs/gatsby/wrapRootElement";
+export { wrapPageElement } from "./src/@rocketseat/gatsby-theme-docs/gatsby/wrapPageElement";