From abfa50c232e85dca91d3a1f840a61d3f4c64ce92 Mon Sep 17 00:00:00 2001 From: Adetomiwa Adesanya Date: Wed, 14 Jul 2021 05:26:42 -0700 Subject: [PATCH] Enable Inpage Editor On flipper sites. Summary: The inpage editor is now enabled on flipper sites {emoji:1f973}{emoji:1f973}. Reviewed By: jknoxville Differential Revision: D29694782 fbshipit-source-id: 7683892adfd54c2ec6644b1a0ead45124692cf8e --- website/docusaurus.config.js | 155 +++++++++++++++++++++++++++-------- website/package.json | 2 +- website/yarn.lock | 20 +++-- 3 files changed, 132 insertions(+), 45 deletions(-) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index e38191767..ab3a253f0 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -8,7 +8,7 @@ */ // start-import-example -const { fbContent, fbInternalOnly } = require('internaldocs-fb-helpers'); +const {fbContent, fbInternalOnly} = require('internaldocs-fb-helpers'); // end-import-example const repoUrl = 'https://github.com/facebook/flipper'; @@ -144,7 +144,14 @@ const siteConfig = { }, }), prism: { - additionalLanguages: ['groovy', 'java', 'kotlin', 'ruby', 'swift', 'objectivec'], + additionalLanguages: [ + 'groovy', + 'java', + 'kotlin', + 'ruby', + 'swift', + 'objectivec', + ], }, }, favicon: 'img/icon.png', @@ -163,23 +170,29 @@ const siteConfig = { docs: { path: '../docs', sidebarPath: require.resolve('./sidebars.js'), - editUrl: 'https://github.com/facebook/flipper/blob/master/website', + editUrl: fbContent({ + internal: + 'https://www.internalfb.com/intern/diffusion/FBS/browse/master/xplat/sonar/website/', + external: 'https://github.com/facebook/flipper/blob/master/website', + }), }, theme: { customCss: require.resolve('./static/css/custom.css'), }, + enableEditor: true, }, ], ], // end_config_example plugins: [ './src/plugins/support-symlinks', - [require.resolve('@docusaurus/plugin-content-pages'), - { - id: 'embedded-pages', - path: './src/embedded-pages/', - mdxPageComponent: '@theme/EmbeddedMDXPage', - } + [ + require.resolve('@docusaurus/plugin-content-pages'), + { + id: 'embedded-pages', + path: './src/embedded-pages/', + mdxPageComponent: '@theme/EmbeddedMDXPage', + }, ], [ '@docusaurus/plugin-client-redirects', @@ -238,33 +251,105 @@ const siteConfig = { to: '/docs/getting-started/index', from: ['/docs/fb/index'], }, - { from: ['/docs/features/network-plugin'], to: '/docs/features/plugins/network' }, - { from: ['/docs/features/logs-plugin'], to: '/docs/features/plugins/device-logs' }, - { from: ['/docs/features/layout-plugin'], to: '/docs/features/plugins/inspector' }, - { from: ['/docs/features/navigation-plugin'], to: '/docs/features/plugins/navigation' }, - { from: ['/docs/features/databases-plugin'], to: '/docs/features/plugins/databases' }, - { from: ['/docs/features/images-plugin'], to: '/docs/features/plugins/fresco' }, - { from: ['/docs/features/sandbox-plugin'], to: '/docs/features/plugins/sandbox' }, - { from: ['/docs/features/shared-preferences-plugin'], to: '/docs/features/plugins/preferences' }, - { from: ['/docs/features/leak-canary-plugin'], to: '/docs/features/plugins/leak-canary' }, - { from: ['/docs/features/crash-reporter-plugin'], to: '/docs/features/plugins/crash-reporter' }, - { from: ['/docs/setup/network-plugin'], to: '/docs/setup/plugins/network' }, - { from: ['/docs/setup/layout-plugin'], to: '/docs/setup/plugins/inspector'}, - { from: ['/docs/setup/navigation-plugin'], to: '/docs/setup/plugins/navigation'}, - { from: ['/docs/setup/databases-plugin'], to: '/docs/setup/plugins/databases'}, - { from: ['/docs/setup/images-plugin'], to: '/docs/setup/plugins/fresco'}, - { from: ['/docs/setup/sandbox-plugin'], to: '/docs/setup/plugins/sandbox'}, - { from: ['/docs/setup/shared-preferences-plugin'], to: '/docs/setup/plugins/preferences'}, - { from: ['/docs/setup/leak-canary-plugin'], to: '/docs/setup/plugins/leak-canary'}, - { from: ['/docs/setup/leak-canary-2-plugin'], to: '/docs/setup/plugins/leak-canary'}, - { from: ['/docs/setup/crash-reporter-plugin'], to: '/docs/setup/plugins/crash-reporter'}, + { + from: ['/docs/features/network-plugin'], + to: '/docs/features/plugins/network', + }, + { + from: ['/docs/features/logs-plugin'], + to: '/docs/features/plugins/device-logs', + }, + { + from: ['/docs/features/layout-plugin'], + to: '/docs/features/plugins/inspector', + }, + { + from: ['/docs/features/navigation-plugin'], + to: '/docs/features/plugins/navigation', + }, + { + from: ['/docs/features/databases-plugin'], + to: '/docs/features/plugins/databases', + }, + { + from: ['/docs/features/images-plugin'], + to: '/docs/features/plugins/fresco', + }, + { + from: ['/docs/features/sandbox-plugin'], + to: '/docs/features/plugins/sandbox', + }, + { + from: ['/docs/features/shared-preferences-plugin'], + to: '/docs/features/plugins/preferences', + }, + { + from: ['/docs/features/leak-canary-plugin'], + to: '/docs/features/plugins/leak-canary', + }, + { + from: ['/docs/features/crash-reporter-plugin'], + to: '/docs/features/plugins/crash-reporter', + }, + { + from: ['/docs/setup/network-plugin'], + to: '/docs/setup/plugins/network', + }, + { + from: ['/docs/setup/layout-plugin'], + to: '/docs/setup/plugins/inspector', + }, + { + from: ['/docs/setup/navigation-plugin'], + to: '/docs/setup/plugins/navigation', + }, + { + from: ['/docs/setup/databases-plugin'], + to: '/docs/setup/plugins/databases', + }, + { + from: ['/docs/setup/images-plugin'], + to: '/docs/setup/plugins/fresco', + }, + { + from: ['/docs/setup/sandbox-plugin'], + to: '/docs/setup/plugins/sandbox', + }, + { + from: ['/docs/setup/shared-preferences-plugin'], + to: '/docs/setup/plugins/preferences', + }, + { + from: ['/docs/setup/leak-canary-plugin'], + to: '/docs/setup/plugins/leak-canary', + }, + { + from: ['/docs/setup/leak-canary-2-plugin'], + to: '/docs/setup/plugins/leak-canary', + }, + { + from: ['/docs/setup/crash-reporter-plugin'], + to: '/docs/setup/plugins/crash-reporter', + }, ...fbInternalOnly([ - { from: ['/docs/fb/Memory-Tools'], to: '/docs/features/plugins/memory-tools' }, - { from: ['/docs/fb/supporting-feed-inspector'], to: '/docs/features/plugins/feed-inspector' }, - { from: ['/docs/fb/sections'], to: '/docs/features/plugins/sections' }, - { from: ['/docs/fb/Trace'], to: '/docs/features/plugins/tracery' }, - { from: ['/docs/fb/mobile-config'], to: '/docs/features/plugins/mobile-config' }, - ]), + { + from: ['/docs/fb/Memory-Tools'], + to: '/docs/features/plugins/memory-tools', + }, + { + from: ['/docs/fb/supporting-feed-inspector'], + to: '/docs/features/plugins/feed-inspector', + }, + { + from: ['/docs/fb/sections'], + to: '/docs/features/plugins/sections', + }, + {from: ['/docs/fb/Trace'], to: '/docs/features/plugins/tracery'}, + { + from: ['/docs/fb/mobile-config'], + to: '/docs/features/plugins/mobile-config', + }, + ]), ], }, ], diff --git a/website/package.json b/website/package.json index 11281f826..5680def7b 100644 --- a/website/package.json +++ b/website/package.json @@ -18,7 +18,7 @@ "@types/fs-extra": "^9.0.11", "classnames": "^2.3.1", "docblock-parser": "^1.0.0", - "docusaurus-plugin-internaldocs-fb": "^0.8.5", + "docusaurus-plugin-internaldocs-fb": "^0.9.0", "file-cli": "^1.2.0", "fs-extra": "^10.0.0", "glob": "^7.1.7", diff --git a/website/yarn.lock b/website/yarn.lock index e73545f69..4a2f944e9 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -5008,12 +5008,14 @@ doctrine@^3.0.0: dependencies: esutils "^2.0.2" -docusaurus-plugin-internaldocs-fb@^0.8.5: - version "0.8.5" - resolved "https://registry.yarnpkg.com/docusaurus-plugin-internaldocs-fb/-/docusaurus-plugin-internaldocs-fb-0.8.5.tgz#8f9d88fd4bce4f3d0601b2ec1369bcba305f53b7" - integrity sha512-cfxfmMB0yb/5b/g0NmjJc8p3WdHx9wI5cqFl5R9uJsg5HF4RR0isHwxAh3/KRCd2MKClILL/relShsnim4oQ9Q== +docusaurus-plugin-internaldocs-fb@^0.9.0: + version "0.9.0" + resolved "https://registry.yarnpkg.com/docusaurus-plugin-internaldocs-fb/-/docusaurus-plugin-internaldocs-fb-0.9.0.tgz#aef519a0fa867549d4718a618b3aa615e2777895" + integrity sha512-mhoRtPN9HKnqHUclyAiA27QqTKPuz5zXHrGqD2h+smxTCRdixmfRHVOXzUAbI8gNSIFXU/Vq8Q1G6NaKcaRs5g== dependencies: - internaldocs-fb-helpers "^1.6.4" + clsx "^1.1.1" + fs-extra "^10.0.0" + internaldocs-fb-helpers "^1.7.0" remark-code-snippets "^1.0.1" remark-mdx-filter-imports "^0.1.2" @@ -6449,10 +6451,10 @@ internal-ip@^4.3.0: default-gateway "^4.2.0" ipaddr.js "^1.9.0" -internaldocs-fb-helpers@^1.6.4: - version "1.6.4" - resolved "https://registry.yarnpkg.com/internaldocs-fb-helpers/-/internaldocs-fb-helpers-1.6.4.tgz#b67cbf83a83cbd720067847af21c499715b9e32a" - integrity sha512-eoMHtKcd7zVp0LNVdCPpP8NJQ9zDyCqQCr/yXL0z4rJdOaZCbsbAbW/We2IBxDKKCg6ItheFAVrAv1PF4v7+Sg== +internaldocs-fb-helpers@^1.7.0: + version "1.7.0" + resolved "https://registry.yarnpkg.com/internaldocs-fb-helpers/-/internaldocs-fb-helpers-1.7.0.tgz#eb647e818f273a298726d956f56b72d3094d9ede" + integrity sha512-WQVMMGPrcI6CGeLx402sXl7gWg5uoV24Xqwxq0kwooCteHeIgnARZsGukQq8T9+oUftxsDsYumaa7eD3iOFwVQ== interpret@^1.0.0: version "1.2.0"