From b1ec05688429651c98b4267beadf375dd81baa0b Mon Sep 17 00:00:00 2001 From: Patrick Boyd Date: Wed, 22 Apr 2020 17:04:27 -0700 Subject: [PATCH] Remove docs package (#178) * Remove all docs content from fluentui-react-native * add headline links to documentation * update yarn.lock * update yarn.lock for merge * re-add images to new assets dir for repo readmes to reference * refresh yarn.lock * refresh yarn.lock cleanly after mege * update yarn.lock Co-authored-by: Chris Hogan --- README.md | 26 +- apps/fluent-tester/README.md | 7 +- .../fluent_tester_debug_menu.png | Bin .../fluent_tester_radiogroup.png | Bin .../fluent_tester_vscode_debug.png | Bin docs/CHANGELOG.json | 110 - docs/CHANGELOG.md | 54 - docs/README.md | 106 - docs/content/toc.yml | 2 - docs/content/windows/components/Callout.mdx | 100 - docs/content/windows/components/Checkbox.mdx | 59 - docs/content/windows/components/button.mdx | 20 - docs/content/windows/components/index.mdx | 4 - docs/content/windows/components/link.mdx | 24 - .../content/windows/components/radiogroup.mdx | 39 - docs/content/windows/components/separator.mdx | 46 - docs/content/windows/components/text.mdx | 3 - docs/content/windows/components/toc.yml | 22 - .../components/utilities/focustrapzone.mdx | 24 - .../components/utilities/pressable.mdx | 3 - .../windows/components/utilities/stack.mdx | 3 - docs/content/windows/counter.jsx | 15 - docs/content/windows/experiences/index.mdx | 3 - docs/content/windows/experiences/toc.yml | 2 - docs/content/windows/get-started/index.mdx | 5 - docs/content/windows/get-started/toc.yml | 2 - docs/content/windows/index.mdx | 50 - docs/content/windows/styles/index.mdx | 5 - docs/content/windows/styles/toc.yml | 2 - docs/gatsby-config.js | 16 - docs/package.json | 72 - docs/pages/HELLO_WORLD.md | 26 - docs/pages/accessibility.mdx | 204 - docs/tsconfig.json | 18 - .../gatsby-plugin-docs-creator/.gitignore | 30 - .../gatsby-plugin-docs-creator/.npmignore | 34 - .../gatsby-plugin-docs-creator/CHANGELOG.json | 50 - .../gatsby-plugin-docs-creator/CHANGELOG.md | 26 - .../docs/gatsby-plugin-docs-creator/README.md | 104 - .../dist/gatsby-node.d.ts | 9 - .../dist/gatsby-node.js | 149 - .../dist/gatsby-node.js.map | 1 - .../gatsby-plugin-docs-creator/gatsby-node.js | 1 - .../gatsby-plugin-docs-creator/package.json | 50 - .../src/gatsby-node.ts | 136 - .../gatsby-plugin-docs-creator/tsconfig.json | 23 - .../docs/gatsby-theme-fluent-site/.eslintrc | 12 - .../.storybook/main.js | 23 - .../ApplicationInsights.md | 96 - .../gatsby-theme-fluent-site/CHANGELOG.json | 69 - .../gatsby-theme-fluent-site/CHANGELOG.md | 33 - .../docs/gatsby-theme-fluent-site/LICENSE | 21 - .../docs/gatsby-theme-fluent-site/README.md | 86 - .../gatsby-theme-fluent-site/gatsby-config.js | 145 - .../gatsby-theme-fluent-site/gatsby-node.js | 29 - .../gatsby-theme-fluent-site/gatsby-ssr.js | 20 - .../gatsby-theme-fluent-site/package.json | 79 - .../gatsby-theme-fluent-site/src/cms/cms.js | 6 - .../ApplicationInsights/AppInsights.tsx | 65 - .../ApplicationInsights/InitAppInsights.tsx | 36 - .../components/ApplicationInsights/index.ts | 3 - .../ApplicationInsights/useEventTelemetry.tsx | 33 - .../usePageViewTelemetry.tsx | 41 - .../src/components/CONTRIBUTING.md | 38 - .../components/Content/PageInnerContent.tsx | 13 - .../src/components/Content/index.ts | 1 - .../src/components/Footer/Footer.tsx | 37 - .../src/components/Footer/FooterMenuItems.tsx | 62 - .../src/components/Footer/index.ts | 1 - .../src/components/Header/Header.tsx | 85 - .../src/components/Header/HeaderMenuItems.tsx | 63 - .../src/components/Header/SubNav.tsx | 54 - .../src/components/Header/index.ts | 2 - .../src/components/Highlight/Highlight.tsx | 21 - .../components/Highlight/HighlightInline.tsx | 21 - .../src/components/Highlight/index.ts | 2 - .../src/components/NYI/NYI.tsx | 42 - .../src/components/NYI/Placeholder.tsx | 28 - .../src/components/NYI/index.ts | 2 - .../src/components/Persona/Persona.tsx | 14 - .../src/components/Persona/index.ts | 0 .../components/Playground/ExamplePreview.tsx | 120 - .../src/components/Playground/Footer.tsx | 217 - .../components/Playground/IFrameRenderer.tsx | 102 - .../Playground/Playground.story.tsx | 89 - .../src/components/Playground/Playground.tsx | 66 - .../src/components/Playground/Sidebar.tsx | 129 - .../src/components/Playground/Viewport.tsx | 116 - .../src/components/Playground/context.ts | 24 - .../src/components/Playground/index.tsx | 1 - .../Playground/plugins/CodeEditor.tsx | 63 - .../Playground/plugins/ThemeEditor.tsx | 24 - .../src/components/Provider/PageContext.ts | 4 - .../src/components/Provider/Provider.tsx | 63 - .../src/components/Provider/index.ts | 1 - .../src/components/STORYBOOK.md | 38 - .../src/components/Search/Search.tsx | 303 - .../src/components/Search/index.ts | 1 - .../src/components/Sidebar/Sidebar.tsx | 64 - .../components/Sidebar/SidebarMenuItems.tsx | 0 .../src/components/Sidebar/index.ts | 1 - .../src/components/StyleTest.story.tsx | 71 - .../src/components/Usage/Example.tsx | 32 - .../src/components/Usage/Usage.tsx | 112 - .../src/components/Usage/index.ts | 2 - .../src/components/useRootStyles.ts | 22 - .../src/hooks/index.ts | 1 - .../src/hooks/useKeyPress.ts | 21 - .../gatsby-theme-fluent-site/src/md2jsx.ts | 10 - .../src/templates/IPageTemplateProps.ts | 10 - .../src/templates/ISidebarItem.ts | 5 - .../src/templates/MDXTemplate.tsx | 20 - .../src/templates/PageShell.tsx | 46 - .../src/templates/PageTemplate.tsx | 37 - .../src/templates/index.ts | 2 - .../static/admin/config.yml | 51 - .../static/favicons/browserconfig.xml | 11 - .../static/favicons/favicon-114.png | Bin 754 -> 0 bytes .../static/favicons/favicon-120.png | Bin 702 -> 0 bytes .../static/favicons/favicon-144.png | Bin 843 -> 0 bytes .../static/favicons/favicon-150.png | Bin 920 -> 0 bytes .../static/favicons/favicon-152.png | Bin 849 -> 0 bytes .../static/favicons/favicon-16.png | Bin 339 -> 0 bytes .../static/favicons/favicon-160.png | Bin 908 -> 0 bytes .../static/favicons/favicon-180.png | Bin 977 -> 0 bytes .../static/favicons/favicon-192.png | Bin 1034 -> 0 bytes .../static/favicons/favicon-310.png | Bin 2027 -> 0 bytes .../static/favicons/favicon-32.png | Bin 412 -> 0 bytes .../static/favicons/favicon-57.png | Bin 547 -> 0 bytes .../static/favicons/favicon-60.png | Bin 497 -> 0 bytes .../static/favicons/favicon-64.png | Bin 525 -> 0 bytes .../static/favicons/favicon-70.png | Bin 581 -> 0 bytes .../static/favicons/favicon-72.png | Bin 543 -> 0 bytes .../static/favicons/favicon-76.png | Bin 551 -> 0 bytes .../static/favicons/favicon-96.png | Bin 633 -> 0 bytes .../static/favicons/favicon.ico | Bin 9326 -> 0 bytes .../static/images/microsoft.svg | 1 - .../gatsby-theme-fluent-site/tsconfig.json | 16 - yarn.lock | 14713 +--------------- 139 files changed, 930 insertions(+), 18647 deletions(-) rename {docs/pages/images => assets}/fluent_tester_debug_menu.png (100%) rename {docs/pages/images => assets}/fluent_tester_radiogroup.png (100%) rename {docs/pages/images => assets}/fluent_tester_vscode_debug.png (100%) delete mode 100644 docs/CHANGELOG.json delete mode 100644 docs/CHANGELOG.md delete mode 100644 docs/README.md delete mode 100644 docs/content/toc.yml delete mode 100644 docs/content/windows/components/Callout.mdx delete mode 100644 docs/content/windows/components/Checkbox.mdx delete mode 100644 docs/content/windows/components/button.mdx delete mode 100644 docs/content/windows/components/index.mdx delete mode 100644 docs/content/windows/components/link.mdx delete mode 100644 docs/content/windows/components/radiogroup.mdx delete mode 100644 docs/content/windows/components/separator.mdx delete mode 100644 docs/content/windows/components/text.mdx delete mode 100644 docs/content/windows/components/toc.yml delete mode 100644 docs/content/windows/components/utilities/focustrapzone.mdx delete mode 100644 docs/content/windows/components/utilities/pressable.mdx delete mode 100644 docs/content/windows/components/utilities/stack.mdx delete mode 100644 docs/content/windows/counter.jsx delete mode 100644 docs/content/windows/experiences/index.mdx delete mode 100644 docs/content/windows/experiences/toc.yml delete mode 100644 docs/content/windows/get-started/index.mdx delete mode 100644 docs/content/windows/get-started/toc.yml delete mode 100644 docs/content/windows/index.mdx delete mode 100644 docs/content/windows/styles/index.mdx delete mode 100644 docs/content/windows/styles/toc.yml delete mode 100644 docs/gatsby-config.js delete mode 100644 docs/package.json delete mode 100644 docs/pages/HELLO_WORLD.md delete mode 100644 docs/pages/accessibility.mdx delete mode 100644 docs/tsconfig.json delete mode 100644 packages/docs/gatsby-plugin-docs-creator/.gitignore delete mode 100644 packages/docs/gatsby-plugin-docs-creator/.npmignore delete mode 100644 packages/docs/gatsby-plugin-docs-creator/CHANGELOG.json delete mode 100644 packages/docs/gatsby-plugin-docs-creator/CHANGELOG.md delete mode 100644 packages/docs/gatsby-plugin-docs-creator/README.md delete mode 100644 packages/docs/gatsby-plugin-docs-creator/dist/gatsby-node.d.ts delete mode 100644 packages/docs/gatsby-plugin-docs-creator/dist/gatsby-node.js delete mode 100644 packages/docs/gatsby-plugin-docs-creator/dist/gatsby-node.js.map delete mode 100644 packages/docs/gatsby-plugin-docs-creator/gatsby-node.js delete mode 100644 packages/docs/gatsby-plugin-docs-creator/package.json delete mode 100644 packages/docs/gatsby-plugin-docs-creator/src/gatsby-node.ts delete mode 100644 packages/docs/gatsby-plugin-docs-creator/tsconfig.json delete mode 100644 packages/docs/gatsby-theme-fluent-site/.eslintrc delete mode 100644 packages/docs/gatsby-theme-fluent-site/.storybook/main.js delete mode 100644 packages/docs/gatsby-theme-fluent-site/ApplicationInsights.md delete mode 100644 packages/docs/gatsby-theme-fluent-site/CHANGELOG.json delete mode 100644 packages/docs/gatsby-theme-fluent-site/CHANGELOG.md delete mode 100644 packages/docs/gatsby-theme-fluent-site/LICENSE delete mode 100644 packages/docs/gatsby-theme-fluent-site/README.md delete mode 100644 packages/docs/gatsby-theme-fluent-site/gatsby-config.js delete mode 100644 packages/docs/gatsby-theme-fluent-site/gatsby-node.js delete mode 100644 packages/docs/gatsby-theme-fluent-site/gatsby-ssr.js delete mode 100644 packages/docs/gatsby-theme-fluent-site/package.json delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/cms/cms.js delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/ApplicationInsights/AppInsights.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/ApplicationInsights/InitAppInsights.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/ApplicationInsights/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/ApplicationInsights/useEventTelemetry.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/ApplicationInsights/usePageViewTelemetry.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/CONTRIBUTING.md delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Content/PageInnerContent.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Content/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Footer/Footer.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Footer/FooterMenuItems.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Footer/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Header/Header.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Header/HeaderMenuItems.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Header/SubNav.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Header/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Highlight/Highlight.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Highlight/HighlightInline.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Highlight/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/NYI/NYI.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/NYI/Placeholder.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/NYI/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Persona/Persona.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Persona/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/ExamplePreview.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/Footer.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/IFrameRenderer.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/Playground.story.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/Playground.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/Sidebar.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/Viewport.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/context.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/index.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/plugins/CodeEditor.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Playground/plugins/ThemeEditor.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Provider/PageContext.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Provider/Provider.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Provider/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/STORYBOOK.md delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Search/Search.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Search/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Sidebar/Sidebar.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Sidebar/SidebarMenuItems.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Sidebar/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/StyleTest.story.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Usage/Example.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Usage/Usage.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/Usage/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/components/useRootStyles.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/hooks/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/hooks/useKeyPress.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/md2jsx.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/templates/IPageTemplateProps.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/templates/ISidebarItem.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/templates/MDXTemplate.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/templates/PageShell.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/templates/PageTemplate.tsx delete mode 100644 packages/docs/gatsby-theme-fluent-site/src/templates/index.ts delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/admin/config.yml delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/browserconfig.xml delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-114.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-120.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-144.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-150.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-152.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-16.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-160.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-180.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-192.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-310.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-32.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-57.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-60.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-64.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-70.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-72.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-76.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon-96.png delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/favicons/favicon.ico delete mode 100644 packages/docs/gatsby-theme-fluent-site/static/images/microsoft.svg delete mode 100644 packages/docs/gatsby-theme-fluent-site/tsconfig.json diff --git a/README.md b/README.md index f1b35ca82a..4574faa9ff 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ If you have an existing React Native project, it's easy to begin using FluentUI ### Prerequisites -* [Standard React Native dependencies](http://facebook.github.io/react-native/docs/getting-started.html#node-python2-jdk) -* [Node.js](https://nodejs.org/en/download/) +- [Standard React Native dependencies](http://facebook.github.io/react-native/docs/getting-started.html#node-python2-jdk) +- [Node.js](https://nodejs.org/en/download/) ### Install FluentUI React Native into an existing project @@ -25,7 +25,25 @@ After successful installation, you can test the package by importing components import { Checkbox } from '@fluentui/react-native'; ``` -Once you have the package installed, check out our [Hello World Fluent page](./docs/pages/HELLO_WORLD.md) to start writing code (Coming Soon). +Once you have the package installed, check out our [Hello World Fluent page](https://github.com/microsoft/fluent-site/blob/master/packages/fluent-website/docs/windows/get-started/Hello-World.mdx) to start writing code (Coming Soon). + +## Documentation + +### Components and Controls + +Our component documentation is hosted in a separate repository, [Microsoft FluentUI Site](https://github.com/Microsoft/fluent-site) that will be published to its own website (Coming Soon). + +### Theming framework + +Our FluentUI framework documentation is found in this repository alongside the implementation. + +- [Theming Overview](./packages/framework/theming-react-native/README.md) +- [StyleSheets](./packages/framework/themed-stylesheet/README.md) +- [Customizing Theme Settings](./packages/framework/themed-settings/README.md) +- [Theme Registry](./packages/framework/theme-registry/README.md) +- [Tokens](./packages/framework/foundation-tokens/README.md) +- [Settings and Slots](./packages/framework/foundation-settings/README.md) +- [Compose](./packages/framework/foundation-compose/README.md) and [Composable](./packages/framework/foundation-composable/README.md) ## Developing in the repo @@ -45,7 +63,9 @@ To start developing in the repository you can: After a successful yarn build, you can explore FluentUI Tester, our demo application to play with each of the controls. To run FluentUI Tester, please follow instructions in the [FluentUI Tester readme](./apps/fluent-tester/README.md). ### Beachball + This repo manages semantic versioning and publishing using [Beachball](https://github.com/microsoft/beachball). When contributing, make sure to run the following before making a pull request: + 1. `yarn change` will take you through a command line wizard to generate change files 2. Make sure to commit and push the newly generated change file diff --git a/apps/fluent-tester/README.md b/apps/fluent-tester/README.md index d6e1c19141..470e2e0544 100644 --- a/apps/fluent-tester/README.md +++ b/apps/fluent-tester/README.md @@ -21,9 +21,10 @@ ``` yarn run-win32 ``` + 5. You will see FluentUI Tester show up in a new window. -![ReactTest image debug menu location](./../../docs/pages/images/fluent_tester_radiogroup.png) +![ReactTest image debug menu location](./../../assets/fluent_tester_radiogroup.png) ## Debug `FluentUI Tester` app with direct debugging @@ -46,11 +47,11 @@ Note: we recommend using [Visual Studio Code](https://code.visualstudio.com/down 5. Inside ReactTest, open the debug option menu and select the checkbox `Use Direct Debugger` -![ReactTest image debug menu location](./../../docs/pages/images/fluent_tester_debug_menu.png) +![ReactTest image debug menu location](./../../assets/fluent_tester_debug_menu.png) 6. In Visual Studio Code, open the debug pane and select `Debug Fabric Tester` option from the "Run And Debug" dropdown. -![ReactTest image debug menu location](./../../docs/pages/images/fluent_tester_vscode_debug.png) +![ReactTest image debug menu location](./../../assets/fluent_tester_vscode_debug.png) 7. At this time, VS Code will attach to the JS runtime and you can start debugging. For more information on debugging in VS Code, please see [Visual Studio Code documentation](https://code.visualstudio.com/docs/editor/debugging). diff --git a/docs/pages/images/fluent_tester_debug_menu.png b/assets/fluent_tester_debug_menu.png similarity index 100% rename from docs/pages/images/fluent_tester_debug_menu.png rename to assets/fluent_tester_debug_menu.png diff --git a/docs/pages/images/fluent_tester_radiogroup.png b/assets/fluent_tester_radiogroup.png similarity index 100% rename from docs/pages/images/fluent_tester_radiogroup.png rename to assets/fluent_tester_radiogroup.png diff --git a/docs/pages/images/fluent_tester_vscode_debug.png b/assets/fluent_tester_vscode_debug.png similarity index 100% rename from docs/pages/images/fluent_tester_vscode_debug.png rename to assets/fluent_tester_vscode_debug.png diff --git a/docs/CHANGELOG.json b/docs/CHANGELOG.json deleted file mode 100644 index eec03e37f3..0000000000 --- a/docs/CHANGELOG.json +++ /dev/null @@ -1,110 +0,0 @@ -{ - "name": "fluent-rn-website", - "entries": [ - { - "date": "Fri, 17 Apr 2020 22:36:03 GMT", - "tag": "fluent-rn-website_v0.3.0", - "version": "0.3.0", - "comments": { - "minor": [ - { - "comment": "yarn.lock", - "author": "warleu@microsoft.com", - "commit": "205e7b7e88151a17f2560ecdaec1c6e13c5825b7", - "package": "fluent-rn-website" - } - ] - } - }, - { - "date": "Fri, 17 Apr 2020 16:48:18 GMT", - "tag": "fluent-rn-website_v0.2.2", - "version": "0.2.2", - "comments": { - "patch": [ - { - "comment": "Revert \"Merge pull request #136 from ksiler/fluent-variant-support\"", - "author": "krsiler@microsoft.com", - "commit": "302097d2dc2dc50680be2ff3747b9c244501d7d5", - "package": "fluent-rn-website" - } - ] - } - }, - { - "date": "Tue, 14 Apr 2020 05:14:46 GMT", - "tag": "fluent-rn-website_v0.2.0", - "version": "0.2.0", - "comments": { - "minor": [ - { - "comment": "add accessibility documentation", - "author": "krsiler@microsoft.com", - "commit": "232a97794dc044cec9671e5cca4cf204d881f614", - "package": "fluent-rn-website" - } - ] - } - }, - { - "date": "Mon, 13 Apr 2020 22:48:23 GMT", - "tag": "fluent-rn-website_v0.1.0", - "version": "0.1.0", - "comments": { - "minor": [ - { - "comment": "add docs for text", - "author": "krsiler@microsoft.com", - "commit": "232a97794dc044cec9671e5cca4cf204d881f614", - "package": "fluent-rn-website" - } - ] - } - }, - { - "date": "Thu, 09 Apr 2020 18:39:15 GMT", - "tag": "fluent-rn-website_v0.0.4", - "version": "0.0.4", - "comments": { - "patch": [ - { - "comment": "merge conflicts", - "author": "ppatboyd@outlook.com", - "commit": "232a97794dc044cec9671e5cca4cf204d881f614", - "package": "fluent-rn-website" - } - ] - } - }, - { - "date": "Thu, 09 Apr 2020 17:35:20 GMT", - "tag": "fluent-rn-website_v0.0.3", - "version": "0.0.3", - "comments": { - "patch": [ - { - "comment": "add some dependencies", - "author": "mgodbolt@microsoft.com", - "commit": "232a97794dc044cec9671e5cca4cf204d881f614", - "package": "fluent-rn-website" - } - ] - } - }, - { - "date": "Wed, 08 Apr 2020 21:26:12 GMT", - "tag": "fluent-rn-website_v0.0.2", - "version": "0.0.2", - "comments": { - "patch": [ - { - "comment": "update package name", - "author": "mgodbolt@microsoft.com", - "commit": "232a97794dc044cec9671e5cca4cf204d881f614", - "package": "fluent-rn-website" - } - ] - } - } - ] -} diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md deleted file mode 100644 index a414e5250f..0000000000 --- a/docs/CHANGELOG.md +++ /dev/null @@ -1,54 +0,0 @@ -# Change Log - fluent-rn-website - -This log was last generated on Fri, 17 Apr 2020 22:36:03 GMT and should not be manually modified. - - - -## 0.3.0 - -Fri, 17 Apr 2020 22:36:03 GMT - -### Minor changes - -- yarn.lock (warleu@microsoft.com) - -## 0.2.2 - -Fri, 17 Apr 2020 16:48:18 GMT - -### Patches - -- Revert "Merge pull request #136 from ksiler/fluent-variant-support" (krsiler@microsoft.com) - -## 0.2.0 - -Tue, 14 Apr 2020 05:14:46 GMT - -### Minor changes - -- add accessibility documentation (krsiler@microsoft.com) - -## 0.1.0 -Mon, 13 Apr 2020 22:48:23 GMT - -### Minor changes - -- add docs for text (krsiler@microsoft.com) -## 0.0.4 -Thu, 09 Apr 2020 18:39:15 GMT - -### Patches - -- merge conflicts (ppatboyd@outlook.com) -## 0.0.3 -Thu, 09 Apr 2020 17:35:20 GMT - -### Patches - -- add some dependencies (mgodbolt@microsoft.com) -## 0.0.2 -Wed, 08 Apr 2020 21:26:12 GMT - -### Patches - -- update package name (mgodbolt@microsoft.com) diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 466ea86eae..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,106 +0,0 @@ -# Fluent Website Content - -__Key Concepts:__ -1. [Folder path === URL](#adding-new-content) -2. [Left hand navigation defined per folder/folder tree](#creating-navigation) -3. [Built with MD, MDX or TSX](#supported-page-formats) -4. [Host your content anywhere](#hosting-your-content) - -## Adding new content - -Files in the `docs` folders are built to a page with the same URL as the relative directory. `index` files will be rendered as the folder's root page. - -`docs/components/button.mdx` will be built to `example.com/components/button.html`. `docs/styles/index.tsx` will be built to `example.com/styles/index.html` - - -## Creating navigation - -The vertical navigation of each page is written in a `toc.yml` file that includes `name`, `link` and any children `items`. - -- `name` is the link text -- `link` is the full url to the page -- `items` is an array of name/link pairs and can be further nested - - -```yml -- name: Components - items: - - name: Button - link: components/button - - name: Toggle - link: components/toggle - -``` - -### Unique navigation for sub controls - -Often you'll want a subsection of the site to have its own navigation. The navigation of each page is based off of the closest `toc.yml` file to the page. - -```md -docs/ - styles.mdx - toc.yml - components/ - button.mdx - toc.yml - foo/ - bar.mdx - -``` - -The `styles` page will have the navigation from `docs/toc.yml` and `button` page will use the navigation found in `docs/components/toc.yml`. - -`docs/foo` does not contain a `toc.yml` so `docs/toc.yml` will be used for `bar.mdx`. - -## Supported page formats - -The Fluid UI Site supports multiple page formats. - -### MDX - -[MDX](https://mdxjs.com/) is a superset of markdown that adds the power of JSX to the file. -This means you can import JSX directly into your markdown content. - -#### Importing JSX into MDX - -```md -import {Button} from 'office-ui-fabric-react' - -## This is a Fabric button - - - -``` - -#### Importing MD into MDX - -Another great feature of MDX is the ability to import other MD or MDX files into a single file. -This is a great way to split content out into multiple files and combine/reuse it. - -```md -import Stuff from './somestuff.md' - -Hello, this is my -``` - -### TSX Files - -TSX files can be used when you need complete control over the page contents. No assumptions will be made about the page contents, styles or meta information (other than URL). - - -#### Leveraging site templates - -Unless your page is meant to be a standalone app, we recommend using the built in `PageTemplate` to render the default page shell. - -```tsx -import React from 'react'; -import PageTemplate from 'gatsby-theme-fluent-site/src/templates/PageTemplate' -import - -export default () => { - return Page Content -} -``` -## Hosting your content - -Gatsby can source pages from multiple locations. Content added to this repo under `docs/ios` could easily be moved to another repo under `fluentui-docs/ios` and produce the exact same page content. This workflow is not yet fully implemented, but it is a core tenent and fully supported by our tech choices. diff --git a/docs/content/toc.yml b/docs/content/toc.yml deleted file mode 100644 index 666ea26121..0000000000 --- a/docs/content/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Windows - link: /windows diff --git a/docs/content/windows/components/Callout.mdx b/docs/content/windows/components/Callout.mdx deleted file mode 100644 index d4d4b8f3de..0000000000 --- a/docs/content/windows/components/Callout.mdx +++ /dev/null @@ -1,100 +0,0 @@ ---- -titleCategory: Design & developer -title: Callout ---- - -import { Usage, Example } from 'gatsby-theme-fluent-site/src/components/Usage'; -import { NYI } from 'gatsby-theme-fluent-site/src/components/NYI'; -import { Playground } from 'gatsby-theme-fluent-site/src/components/Playground'; - - - -## Overview - -Callouts are a powerful way to simplify a user interface. They host tips and other information users need when they need it, with minimal effort on their part. Callouts can help you use screen space more effectively and reduce screen clutter. However, poorly designed Callouts can be annoying, distracting, unhelpful, overwhelming, or in the way. - -Use a Callout for displaying additional contextual information about an item on the screen. Callouts also have a tail that identifies their source. A common use for Callout is the introduction of a new feature or capability of an app or site. Alternate usages include pairing the Callout with a button or clickable element for on-demand presentation of additional or supporting content. - -By default, Callouts that do not contain focusable elements (links, buttons etc) cannot gain focus when opened. For proper screen reader support, follow the non-focusable callout example, which treats the callout content like a status message. - -[Design spec]() | -[GitHub](https://github.com/microsoft/fluentui-react-native/tree/master/packages/components/Callout) - -export const themes = ['Light', 'Dark']; -export const examples = [ - { - title: 'Simple Callout', - description: "We don't have FluentUI working in the examples yet.", - source: 'export default () => React Native Callout control' - } -]; - - - -## Best practices - -Content needed: best practices - -### Usage - -Content needed: usage examples - -### Layout - -Content needed: positioning, anchoring - -### Accessibility - -Content needed: explain specifics of ARIA properties; mind 'announce' in particular - -### Globalization - -Content needed: any int'l concerns - -## How to customize - -Content needed: add a customization example - -You can customize the appearance of this and other controls by overriding its _design tokens_. Controls in your UI should be consistent in appearance, so most changes to a control's appearance should affect _all_ controls of the same type in your app. If you need a one-off style, however, you can override the design tokens for a single instance of a control. - -- [Overview: How to use design tokens](/web/styles) - -Each control uses many different design tokens. To explore the design tokens that affect this control, select "Design tokens" in the the playground at the top of this page. - -## Related components - -Content needed - -## In-depth examples - -Content needed - -### Additional examples - -Content needed -Explain the actual process of overriding design tokens (which doesn't exist yet) - -## Implementation status - -This control is **unfinished**. The table below shows the current status of the implementation. - -✓ Design specifications and UI kits - -✓ Theming and spacing - -✓ Motion - -✓ Design tokens - -✓ Responsive - -### Issues - -#### Is this page helpful? - -👍 Yes 👎 No diff --git a/docs/content/windows/components/Checkbox.mdx b/docs/content/windows/components/Checkbox.mdx deleted file mode 100644 index 6b5080fd46..0000000000 --- a/docs/content/windows/components/Checkbox.mdx +++ /dev/null @@ -1,59 +0,0 @@ -# Component Name: Checkbox - -## Purpose: -The goal of this Checkbox component is to allows users to switch between two mutually exclusive options (checked or unchecked, -on or off) through a single click or tap. It can also be used to indicate a subordinate setting or preference when paired with another control. - -## Do's: - - Allow users to choose any combination of options when several Checkboxes are grouped together. - -## Don't: - - Don't use a Checkbox as an on/off control. Instead use a toggle switch. - - Don’t use a Checkbox when the user can choose only one option from the group, use radio buttons instead. - - Don't put two groups of Checkboxes next to each other. Separate the two groups with labels. - -## Sample Code: -``` - - -``` - -## Tokens: -Checkbox supports the following tokens: - 1. checkboxBackgroundColor – This changes the background color of the Checkbox. - 2. checkboxBorderColor – This changes the border color of the Checkbox. - 3. checkmarkColor – This changes the color of Checkmark. - 4. borderRadius - This changes the border radius of the Checkbox (use this to create a circular checkbox) - -## Token Usage Example: -Circular Checkbox: We use "borderRadius=7" right now because we currently don't support % for borderRadius. The checkbox -size is currently 14x14, so 7 is 50%. We have a task to allow for %'s. - ``` - const CircularCheckbox = Checkbox.customize({ tokens: { borderRadius: 7 } }); - ``` - -Checkbox with white background (when unchecked): - ``` - const WhiteCheckbox = Checkbox.customize({ tokens: { backgroundColor: 'white' } }); - ``` - -Circular Color-Customized Checkbox - (Green background + green border + white checkmark) when Checked. - ``` - const CircleColorCheckbox = Checkbox.customize({ - tokens: { borderRadius: 7 }, - _overrides: { - checked: { - tokens: { - checkboxBackgroundColor: 'green', - checkboxBorderColor: 'green', - checkmarkColor: 'white' - } - }, - focused: { tokens: { checkboxBackgroundColor: 'menuItemBackgroundHovered' } }, - hovered: { tokens: { checkboxBackgroundColor: 'menuItemBackgroundHovered' } }, - pressed: { tokens: { checkboxBackgroundColor: 'menuItemBackgroundPressed' } } - } - }); - ``` - - diff --git a/docs/content/windows/components/button.mdx b/docs/content/windows/components/button.mdx deleted file mode 100644 index a65dbc4af8..0000000000 --- a/docs/content/windows/components/button.mdx +++ /dev/null @@ -1,20 +0,0 @@ -# Button Documentation - -## Example - -``` -import * as React from 'react'; -import { Button, View } from '@fluentui/react-native'; - -export const ButtonExample: React.FunctionComponent<{}> = props => { - return ( - - - - ); -}; - -export default Counter; diff --git a/docs/content/windows/experiences/index.mdx b/docs/content/windows/experiences/index.mdx deleted file mode 100644 index 7cc411d4c4..0000000000 --- a/docs/content/windows/experiences/index.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Experiences ---- diff --git a/docs/content/windows/experiences/toc.yml b/docs/content/windows/experiences/toc.yml deleted file mode 100644 index 736364a649..0000000000 --- a/docs/content/windows/experiences/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Example - link: windows diff --git a/docs/content/windows/get-started/index.mdx b/docs/content/windows/get-started/index.mdx deleted file mode 100644 index 46c855f0d1..0000000000 --- a/docs/content/windows/get-started/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Get started ---- - -# diff --git a/docs/content/windows/get-started/toc.yml b/docs/content/windows/get-started/toc.yml deleted file mode 100644 index 736364a649..0000000000 --- a/docs/content/windows/get-started/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Example - link: windows diff --git a/docs/content/windows/index.mdx b/docs/content/windows/index.mdx deleted file mode 100644 index 21cff006e3..0000000000 --- a/docs/content/windows/index.mdx +++ /dev/null @@ -1,50 +0,0 @@ -import Counter from './counter.jsx'; - -# JDX in MDX - -You can import React components in an `.mdx` file. Like this: - -> ```jsx -> import Counter from './counter.jsx'; -> ; -> ``` - - - -# FluentUI Docs - -## Components - -- [Button](/windows/components/button) -- [Link](/windows/components/link) -- [Separator](/windows/components/separator) -- [Text](/windows/components/text) - -## Utilities - -- [FocusTrapZone](/windows/components/utilities/focustrapzone) -- [Pressable](/windows/components/utilities/pressable) -- [Stack](/windows/components/utilities/stack) - -## Contributing Docs - -- Follow and maintain the template below -- Run the local dev server with: - > ``` - > cd fluentui-react-native - > yarn - > cd Docs - > yarn dev - > ``` - -## Template - -> ``` -> # Component Name -> -> ## Purpose -> -> ## Do's and Don'ts -> -> ## Sample Code -> ``` diff --git a/docs/content/windows/styles/index.mdx b/docs/content/windows/styles/index.mdx deleted file mode 100644 index e61c6f46fb..0000000000 --- a/docs/content/windows/styles/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Styles ---- - -styles diff --git a/docs/content/windows/styles/toc.yml b/docs/content/windows/styles/toc.yml deleted file mode 100644 index 736364a649..0000000000 --- a/docs/content/windows/styles/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Example - link: windows diff --git a/docs/gatsby-config.js b/docs/gatsby-config.js deleted file mode 100644 index 52670119aa..0000000000 --- a/docs/gatsby-config.js +++ /dev/null @@ -1,16 +0,0 @@ -module.exports = { - siteMetadata: { - siteURL: 'https://fluentui.z5.web.core.windows.net/', - }, - plugins: [ - `gatsby-plugin-typescript`, - `gatsby-plugin-sharp`, - 'gatsby-transformer-sharp', - { - resolve: `gatsby-theme-fluent-site`, - options: { - contentPath: `./content`, - }, - }, - ], -}; diff --git a/docs/package.json b/docs/package.json deleted file mode 100644 index 0eb67801e2..0000000000 --- a/docs/package.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "name": "fluent-rn-website", - "version": "0.3.5", - "description": "Fluent website content", - "repository": { - "type": "git", - "url": "https://github.com/microsoft/fluent-site" - }, - "license": "MIT", - "scripts": { - "clean": "gatsby clean", - "build": "gatsby build --prefix-paths", - "develop": "gatsby clean && gatsby develop --port 3000", - "serve": "gatsby serve", - "start": "npm run develop" - }, - "devDependencies": { - "gatsby-theme-fluent-site": "^0.2.0", - "gatsby-plugin-sharp": "^2.3.13", - "gatsby-transformer-sharp": "^2.3.12" - }, - "dependencies": { - "@babel/core": "^7.8.3", - "@mdx-js/mdx": "^1.1.0", - "@mdx-js/react": "^1.0.27", - "@storybook/addon-actions": "^5.3.4", - "@storybook/addon-links": "^5.3.4", - "@storybook/addons": "^5.3.4", - "@storybook/react": "^5.3.4", - "@types/graphql": "^14.2.0", - "@types/node": "^11.13.13", - "@types/react": "^16.8.19", - "@types/react-dom": "^16.8.4", - "@types/react-helmet": "^5.0.8", - "babel-loader": "^8.0.6", - "gatsby-image": "^2.2.38", - "gatsby-link": "^2.2.2", - "gatsby-plugin-docs-creator": "^2.2.0", - "gatsby-plugin-manifest": "^2.2.20", - "gatsby-plugin-mdx": "^1.0.67", - "gatsby-plugin-netlify-cms": "^4.2.2", - "gatsby-plugin-offline": "^3.0.32", - "gatsby-plugin-react-helmet": "^3.1.21", - "gatsby-plugin-sharp": "^2.3.13", - "gatsby-remark-copy-linked-files": "^2.1.36", - "gatsby-remark-images": "^3.1.42", - "gatsby-remark-prismjs": "^3.3.30", - "gatsby-source-filesystem": "^2.1.46", - "gatsby-source-git": "^1.0.2", - "gatsby-transformer-remark": "^2.6.48", - "gatsby-transformer-sharp": "^2.3.12", - "gatsby-transformer-yaml": "^2.2.24", - "monaco-editor-webpack-plugin": "^1.9.0", - "netlify-cms-app": "^2.12.2", - "office-ui-fabric-react": "^7.92.0", - "prism-react-renderer": "^1.0.1", - "react-helmet": "^5.2.1", - "react-live": "^2.1.2", - "react-monaco-editor": "^0.34.0", - "remark-parse": "^7.0.0", - "remark-react": "^6.0.0", - "unified": "^8.3.2", - "gatsby-plugin-typescript": "^2.1.26", - "typescript": "^3.5.1", - "gatsby": "^2.19.27", - "gatsby-plugin-emotion": "^4.1.23", - "react": "^16.13.0", - "react-dom": "^16.13.0", - "@fluentui/react-native": "^0.15.5", - "@mdx-js/loader": "^1.5.5" - } -} diff --git a/docs/pages/HELLO_WORLD.md b/docs/pages/HELLO_WORLD.md deleted file mode 100644 index 87336a3179..0000000000 --- a/docs/pages/HELLO_WORLD.md +++ /dev/null @@ -1,26 +0,0 @@ -# Hello World Fluent - -Now that you have the FluentUI React Native package installed, we will add components from the library to a new React Native project. - -``` -// In App.js in a new project - -import React from 'react'; -import { View, Text } from 'react-native'; -import { Checkbox } from '@fluentui/react-native'; - -function HelloWorldApp() { - return ( - - Hello, world! - - - ) -} -export default HelloWorldApp; -``` \ No newline at end of file diff --git a/docs/pages/accessibility.mdx b/docs/pages/accessibility.mdx deleted file mode 100644 index 3ff9bd4ceb..0000000000 --- a/docs/pages/accessibility.mdx +++ /dev/null @@ -1,204 +0,0 @@ -# Accessibility - -Accessibility means designing and creating UI that's accessible to all users, including those with disabilities. -It's important to create accessible UI so that assitive technology, like screen readers, can access information users -need to interact with your controls. Here you can find a guide to get started as well as tools to help you test your UI -for accessibility. - -## Our Approach -FluentUI React Native enables developers to create accessible UI by providing APIs that are complimentary to Microsoft -UI Automation (UIA), an accessibility framework for Windows. Our API surface is heavily inspired by Accessible Internet Rich -Applications (ARIA), an accessibility framework for the web. We chose to align with ARIA to provide a "web first" -development experience. ARIA also provides a lot of guidelines and best practices for creating accessible content. - -## Making UI accessible - -FluentUI React Native components are accessible by default meaning you only need to provide minimal customizations to make -your UI accessible. Here you will find information on the folowing components: Properties, Roles, States, and Actions. - -### Properties - -#### accessible -When `true`, indicates that the view is an accessible element meaning it receives accessibility focus. By default, all -controls are accessible. - -```tsx -first -second -``` - -In the above example, 'first' recieves accessiblity focus but 'second' does not. - - -#### accessibilityLabel -When something is accessible, it's good practice to set an `accessiblityLabel` so the user knows what element has focus. Narrator will read out this string when the user places focus on the control. - -To use, set the `accessibilityLabel` property to a custom string: - -```tsx - -) - -``` - -*EventView With Name/Value Property* -```jsx -import { useEventTelemetry } from '../components/ApplicationInsights' - -... - - const [myEvent, invokeMyEventTelemetry] = useEventTelemetry({ name: 'MyEvent' }) - - const sendEvent = (buttonId:number) => { - myEvent.properties = myEvent.properties ? myEvent.properties : [] - myEvent.properties["Button_Clicked"] = buttonId - // this call will send the update and send the telementry data - invokeMyEventTelemetry(myEvent) - - } - -return ( - - -) - -``` - -## IMPORTANT! Build notes -*NOTE -For production builds you need to set GATBSY_APPLICATIONINSIGHTS_KEY to the value of the production key *prior* to -a production build. This can be done as an evironment variable or in the .env.production file under src/website. -The key is retrieved from the Application Insights app on https://portal.azure.com - -For development/test builds, modify the .env.developement file. - -## NPM Packages -NPM package(s): -@microsoft/applicationinsights-web -@microsoft/applicationinsights-react-js - -## Resources -[Azure Portal Resource](https://ms.portal.azure.com/#@microsoft.onmicrosoft.com/resource/subscriptions/9ccbac18-03d3-485b-a43e-87dc09014817/resourcegroups/OXOSharedRG/providers/microsoft.insights/components/FluentUI-Website/overview) - -[Javascript NPM Setup](https://docs.microsoft.com/en-us/azure/azure-monitor/app/javascript#npm-based-setup) - -[Application Insights React](https://github.com/microsoft/ApplicationInsights-JS/blob/17ef50442f73fd02a758fbd74134933d92607ecf/extensions/applicationinsights-react-js/README.md) diff --git a/packages/docs/gatsby-theme-fluent-site/CHANGELOG.json b/packages/docs/gatsby-theme-fluent-site/CHANGELOG.json deleted file mode 100644 index ffe935a2ae..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/CHANGELOG.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "name": "gatsby-theme-fluent-site", - "entries": [ - { - "date": "Fri, 17 Apr 2020 22:36:03 GMT", - "tag": "gatsby-theme-fluent-site_v0.2.0", - "version": "0.2.0", - "comments": { - "minor": [ - { - "comment": "yarn.lock", - "author": "warleu@microsoft.com", - "commit": "205e7b7e88151a17f2560ecdaec1c6e13c5825b7", - "package": "gatsby-theme-fluent-site" - } - ] - } - }, - { - "date": "Thu, 09 Apr 2020 18:39:15 GMT", - "tag": "gatsby-theme-fluent-site_v0.1.3", - "version": "0.1.3", - "comments": { - "patch": [ - { - "comment": "merge conflicts", - "author": "ppatboyd@outlook.com", - "commit": "232a97794dc044cec9671e5cca4cf204d881f614", - "package": "gatsby-theme-fluent-site" - } - ] - } - }, - { - "date": "Wed, 08 Apr 2020 21:26:12 GMT", - "tag": "gatsby-theme-fluent-site_v0.1.2", - "version": "0.1.2", - "comments": { - "patch": [ - { - "comment": "update package name", - "author": "mgodbolt@microsoft.com", - "commit": "232a97794dc044cec9671e5cca4cf204d881f614", - "package": "gatsby-theme-fluent-site" - } - ] - } - }, - { - "date": "Sat, 27 Jul 2019 05:29:12 GMT", - "tag": "gatsby-starter-uifabric-doc_v0.1.1", - "version": "0.1.1", - "comments": { - "patch": [ - { - "comment": "initial publish", - "author": "kchau@microsoft.com", - "commit": "d5ff88bc7ddf21d5e9035f4a95503df50709f55c" - }, - { - "comment": "initial release", - "author": "kchau@microsoft.com", - "commit": "e9f0dccdd68a5890a3a063b79314d3ea446a95da" - } - ] - } - } - ] -} diff --git a/packages/docs/gatsby-theme-fluent-site/CHANGELOG.md b/packages/docs/gatsby-theme-fluent-site/CHANGELOG.md deleted file mode 100644 index b6875ba483..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/CHANGELOG.md +++ /dev/null @@ -1,33 +0,0 @@ -# Change Log - gatsby-theme-fluent-site - -This log was last generated on Fri, 17 Apr 2020 22:36:03 GMT and should not be manually modified. - - - -## 0.2.0 - -Fri, 17 Apr 2020 22:36:03 GMT - -### Minor changes - -- yarn.lock (warleu@microsoft.com) - -## 0.1.3 -Thu, 09 Apr 2020 18:39:15 GMT - -### Patches - -- merge conflicts (ppatboyd@outlook.com) -## 0.1.2 -Wed, 08 Apr 2020 21:26:12 GMT - -### Patches - -- update package name (mgodbolt@microsoft.com) -## 0.1.1 -Sat, 27 Jul 2019 05:29:12 GMT - -### Patches - -- initial publish (kchau@microsoft.com) -,- initial release (kchau@microsoft.com) diff --git a/packages/docs/gatsby-theme-fluent-site/LICENSE b/packages/docs/gatsby-theme-fluent-site/LICENSE deleted file mode 100644 index 20f91f2b3c..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2018 gatsbyjs - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/packages/docs/gatsby-theme-fluent-site/README.md b/packages/docs/gatsby-theme-fluent-site/README.md deleted file mode 100644 index b51a594804..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/README.md +++ /dev/null @@ -1,86 +0,0 @@ -## 🚀 Quick start - - -1. **Start developing.** - - ```sh - yarn - yarn start - ``` - -1. **Open the source code and start editing!** - - Your site is now running at `http://localhost:3000`! - - _Note: You'll also see a second link: _`http://localhost:3000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._ - -1. Working with [NetlifyCMS](https://www.netlifycms.org/) - - NetlifyCMS is a React application that sites on top of the markdown content in git and provides a user friendly interface for creating, editing, and reviewing proposed content changes. - - To develop new collections and work within NetlifyCMS's `static/admin/config.yml` file, you can now run a local server and allow the CMS to create and edit your local files - - ```sh - npx netlify-cms-proxy-server - # while server is running, in a seperate terminal run - yarn start - ``` - - Now when you navigate to `http://localhost:3000/admin/` you will be allowed to log in without authentication, and any file change will only change your local data. No git involved. - - -## 🧐 What's inside? - -A quick look at the top-level files and directories you'll see in a the Website package. - - . - ├── src - ├── gatsby-browser.js - ├── gatsby-config.js - ├── gatsby-node.js - ├── gatsby-ssr.js - ├── LICENSE - ├── package-lock.json - ├── package.json - └── README.md - - - -2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”. - - -5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. - -6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail). - -7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. - -8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. - -9. **`LICENSE`**: Gatsby is licensed under the MIT license. - -11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. - -12. **`README.md`**: A text file containing useful reference information about your project. - -## 🎓 Learning Gatsby - -Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start: - -- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. - -- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar. - -## 💫 Deploy - -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-hello-world) - - - -## Developing Components - -Check out [README](./src/components/CONTRIBUTING.md) in the components directory. - -## Storybook - -A playground for developing components in isolation [README](./src/components/STORYBOOK.md) diff --git a/packages/docs/gatsby-theme-fluent-site/gatsby-config.js b/packages/docs/gatsby-theme-fluent-site/gatsby-config.js deleted file mode 100644 index 39c023d420..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/gatsby-config.js +++ /dev/null @@ -1,145 +0,0 @@ -require('dotenv').config({ - path: `.env.${process.env.NODE_ENV}`, -}) -module.exports = themeOptions => { - const { contentPath, pathPrefix } = themeOptions - return { - pathPrefix: pathPrefix || '', - siteMetadata: { - title: 'Microsoft Design - Fluent', - description: - 'Fluent brings the fundamentals of principled design, innovation in technology, and customer needs together as one. It’s a collective approach to creating simplicity and coherence through a shared, open design system across platforms.', - siteURL: 'https://fluentui.z5.web.core.windows.net/', - headerLinks: [ - { - name: 'Fundamentals', - link: '/fundamentals', - headerOnly: true, - }, - { - name: 'Web', - link: '/web', - }, - { - name: 'Windows', - link: '/windows', - }, - { - name: 'iOS', - link: '/ios', - }, - { - name: 'Android', - link: '/android', - }, - { - name: 'Mac', - link: '/mac', - }, - ], - topLinks: [ - { name: 'Get started', link: 'get-started' }, - { name: 'Styles & Theming', link: 'styles' }, - { name: 'Experiences', link: 'experiences' }, - { name: 'Components', link: 'components' }, - ], - footerLinks: [ - { - name: 'Resources', - link: '/resources', - ariaLabel: 'This link will take you to the Resources page', - }, - { - name: "What's new", - link: '/whatsnew', - ariaLabel: "This link will take you to the What's new page", - }, - { - name: 'GitHub', - link: 'https://github.com/microsoft/fluent-site', - target: '_blank', - ariaLabel: 'This link will take you to the Microsoft Fluent UI GitHub site in a new window.', - }, - { - name: 'Privacy & cookies', - link: 'https://privacy.microsoft.com/en-us/privacystatement', - ariaLabel: 'This link will take you to the Microsoft privacy statement.', - }, - ], - homePageData: { - news: [ - { - title: 'Lorem ipsum dolor sit amet, consectet adipiscing elit. Vivamus ut max velit, ut iaculis est. Nullam tincidunt.', - link: '#', - }, - { - title: 'Lorem ipsum dolor sit amet, consectet adipiscing elit. Vivamus ut max velit, ut iaculis est. Nullam tincidunt.', - link: '#', - }, - { - title: 'Lorem ipsum dolor sit amet, consectet adipiscing elit. Vivamus ut max velit, ut iaculis est. Nullam tincidunt.', - link: '#', - }, - { - title: 'Lorem ipsum dolor sit amet, consectet adipiscing elit. Vivamus ut max velit, ut iaculis est. Nullam tincidunt.', - link: '#', - }, - ], - }, - }, - plugins: [ - `gatsby-plugin-emotion`, - `gatsby-transformer-yaml`, - `gatsby-plugin-react-helmet`, - `gatsby-plugin-typescript`, - 'gatsby-plugin-sharp', - 'gatsby-transformer-sharp', - `gatsby-plugin-offline`, - { - resolve: `gatsby-plugin-netlify-cms`, - options: { - modulePath: `${__dirname}/src/cms/cms.js`, - }, - }, - { - resolve: `gatsby-plugin-manifest`, - options: { - name: `Fabric Website 2.0`, - short_name: `fabricwebsite`, - start_url: `/`, - background_color: `#f7f0eb`, - theme_color: `#a2466c`, - display: `standalone`, - }, - }, - { - resolve: `gatsby-plugin-mdx`, - options: { - defaultLayouts: { - default: require.resolve('./src/templates/MDXTemplate.tsx'), - }, - gatsbyRemarkPlugins: [ - { - resolve: `gatsby-remark-images`, - options: { - maxWidth: 400, - withWebp: true, - tracedSVG: true, - linkImagesToOriginal: false, - }, - }, - { - resolve: `gatsby-remark-copy-linked-files`, - }, - ], - }, - }, - { - resolve: `gatsby-plugin-docs-creator`, - options: { - path: contentPath, - }, - }, - ], - } -} diff --git a/packages/docs/gatsby-theme-fluent-site/gatsby-node.js b/packages/docs/gatsby-theme-fluent-site/gatsby-node.js deleted file mode 100644 index 4f9d7fcb5c..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/gatsby-node.js +++ /dev/null @@ -1,29 +0,0 @@ -const path = require('path') -const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin') - -exports.onCreatePage = ({ page, actions }) => { - const { createPage, deletePage } = actions -} - -exports.createPages = async ({ actions, graphql }) => { - const { createPage } = actions -} - -exports.onCreateWebpackConfig = ({ stage, actions }) => { - if (stage.startsWith('develop')) { - actions.setWebpackConfig({ - resolve: { - alias: { - 'react-dom': '@hot-loader/react-dom', - }, - }, - }) - } - actions.setWebpackConfig({ - plugins: [ - new MonacoWebpackPlugin({ - languages: ['typescript'], - }), - ], - }) -} diff --git a/packages/docs/gatsby-theme-fluent-site/gatsby-ssr.js b/packages/docs/gatsby-theme-fluent-site/gatsby-ssr.js deleted file mode 100644 index 9255a63c8a..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/gatsby-ssr.js +++ /dev/null @@ -1,20 +0,0 @@ -import { Stylesheet, InjectionMode } from '@uifabric/merge-styles' -import { renderStatic } from '@uifabric/merge-styles/lib/server' -import { renderToString } from 'react-dom/server' -import React from 'react' - -const config = require('./gatsby-config') - -export const replaceRenderer = ({ bodyComponent, replaceBodyHTMLString, setHeadComponents }) => { - const { html, css } = renderStatic(() => { - return renderToString(bodyComponent) - }) - - replaceBodyHTMLString(html) - - setHeadComponents([
`) - doc.close() - this._setInitialContent = true - } - - const mountTarget = this.getMountTarget() - const win = doc.defaultView || doc.parentView - - // Do not allow elements to be focused within the iframe - win.HTMLElement.prototype.focus = () => {} - - const ctx = { window: win, document: doc } - const content = this.props.children(ctx) || null - return ReactDOM.createPortal(content, mountTarget) - } - - render() { - const { children, ...rest } = this.props - return ( - - ) - } -} diff --git a/packages/docs/gatsby-theme-fluent-site/src/components/Playground/Playground.story.tsx b/packages/docs/gatsby-theme-fluent-site/src/components/Playground/Playground.story.tsx deleted file mode 100644 index 03803a3595..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/src/components/Playground/Playground.story.tsx +++ /dev/null @@ -1,89 +0,0 @@ -import React from 'react' -import { Playground } from '.' -import { Global, css } from '@emotion/core' - -export default { - title: 'Playground', - component: Playground, -} - -// TODO: should share this with the main app and other stories. -const GlobalStyles = () => ( - -) - -export const ToStorybook = () => { - const examples = [ - { - title: 'Hello World', - description: 'Description for the first example', - source: `import * as React from "react" - -export default () =>

Hello World!

`, - }, - { - title: 'Goodbye World', - description: 'Description for the second example', - source: `import * as React from "react" - -export default () =>

Goodbye World?

`, - }, - { - title: 'RTL Example', - description: 'Description for the third example', - source: `import * as React from "react" - -export default () => ( -
- - -
-)`, - }, - { - title: 'Theme Example', - description: 'Description for the third example', - source: `import * as React from "react" - -export default ({ theme }) => { - const style = { - padding: "1rem" - } - switch (theme) { - case "Dark": - style.background = "#333" - style.color = "#eee" - break - case "High Contrast": - style.background = "#000" - style.color = "#fff" - break - } - return

Current theme: {theme}

-}`, - }, - ] - const themes = ['Light', 'Dark', 'High Contrast'] - return ( - <> - - - - ) -} - -ToStorybook.story = { - name: 'Basic', -} diff --git a/packages/docs/gatsby-theme-fluent-site/src/components/Playground/Playground.tsx b/packages/docs/gatsby-theme-fluent-site/src/components/Playground/Playground.tsx deleted file mode 100644 index 79e86b89dd..0000000000 --- a/packages/docs/gatsby-theme-fluent-site/src/components/Playground/Playground.tsx +++ /dev/null @@ -1,66 +0,0 @@ -import * as React from 'react' -import styled from '@emotion/styled' -import { PlaygroundProvider, IPlayground, IExample } from './context' -import { Sidebar } from './Sidebar' -import { Viewport } from './Viewport' -import { Footer } from './Footer' - -function handleAction(state: IPlayground, action: any): IPlayground { - switch (action.type) { - case 'TOGGLE_RTL': - return { ...state, rtl: !state.rtl } - case 'CHANGE_THEME': - return { ...state, currentTheme: action.payload } - case 'CHANGE_EXAMPLE': - return { ...state, currentExample: action.payload } - case 'CHANGE_RESOLUTION': - return { ...state, resolution: action.payload } - case 'CHANGE_ZOOM_LEVEL': - return { ...state, zoomLevel: action.payload } - case 'CHANGE_CURRENT_EXAMPLE_SOURCE': - return { ...state, currentExample: { ...state.currentExample, source: action.payload } } - case 'TOGGLE_PLUGIN': - return { ...state, currentPlugin: state.currentPlugin === action.payload ? null : action.payload } - default: - console.warn('Missing handler for action: %s', action.type) - return state - } -} - -export const Playground = ({ examples = [], themes = [] }: { examples: IExample[]; themes: string[] }) => { - // TODO: ensure state stays in sync with changes to examples/themes props. - const playground = React.useReducer(handleAction, { - examples, - themes, - rtl: false, - zoomLevel: 1, - resolution: 'Responsive', - currentExample: examples[0], - currentTheme: themes[0], - currentPlugin: null, - }) - - return ( - - - - - - -