Skip to content

Commit

Permalink
Merge branch 'microsoft:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
srmukher authored Jan 15, 2024
2 parents 173a1d0 + 7507730 commit e9998fc
Show file tree
Hide file tree
Showing 16 changed files with 6,952 additions and 68 deletions.
13 changes: 12 additions & 1 deletion .github/workflows/testCoverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ on:
schedule:
- cron: "0 0 * * *"
workflow_dispatch:
inputs:
repo:
description: 'Repo to run the tests on'
required: true
default: "microsoft/fluentui"
branch:
description: 'Branch to run the tests on'
required: true
default: "master"


# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
Expand All @@ -29,7 +39,8 @@ jobs:
- name: Checkout [react-charting]
uses: actions/checkout@v4
with:
repository: "microsoft/fluentui"
repository: ${{ github.event.inputs.repo }}
ref: ${{ github.event.inputs.branch }}
path: repo1

- name: Show current directory
Expand Down
27 changes: 18 additions & 9 deletions apps/docsite/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import remarkMath from 'remark-math';
import rehypeKatex from 'rehype-katex';
import remarkMath from "remark-math";
import rehypeKatex from "rehype-katex";

const config: Config = {
title: "FluentUI Charting Contrib Docsite",
Expand All @@ -21,7 +21,7 @@ const config: Config = {
projectName: "fluentui-charting-contrib", // Usually your repo name.
deploymentBranch: "gh-pages",
trailingSlash: false,
staticDirectories: ['../../docs/assets', 'static'],
staticDirectories: ["../../docs/assets", "static"],

onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
Expand All @@ -39,7 +39,7 @@ const config: Config = {
"classic",
{
docs: {
path: '../../docs',
path: "../../docs",
sidebarPath: "./sidebars.ts",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
Expand All @@ -57,11 +57,11 @@ const config: Config = {

stylesheets: [
{
href: 'https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css',
type: 'text/css',
href: "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css",
type: "text/css",
integrity:
'sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM',
crossorigin: 'anonymous',
"sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM",
crossorigin: "anonymous",
},
],

Expand Down Expand Up @@ -123,12 +123,21 @@ const config: Config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} FluentUI React Charting. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} Microsoft`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
algolia: {
appId: "XZ2D9M7V2V",

apiKey: "dbef9c4c79e37ac05ce104dbd93faeec",

indexName: "fluentui-charting-contrib",

contextualSearch: false,
},
} satisfies Preset.ThemeConfig,
};

Expand Down
16 changes: 12 additions & 4 deletions apps/docsite/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,18 @@ const sidebars: SidebarsConfig = {
// But you can create a sidebar manually

tutorialSidebar: [
'Fluent-React-Charting',
'TechnicalDetails',
'Overview',
'CHANGELOG',
'Start Developing',
'Contributor Guide',
'Technical Details',
'Detailed Implementation Steps',
'Debugging',
'Implementation Best Practices',
'Accessibility',
'colors',
'implementing-2-to-1-spacing',
'TestingStrategy',
'Testing Strategy',
{
type:'category',
label:'Test Plans',
Expand All @@ -31,7 +38,8 @@ const sidebars: SidebarsConfig = {
dirName:'Test Plans',
}
]
}
},
'Testing Unpublished Library Version',
],

};
Expand Down
18 changes: 18 additions & 0 deletions docs/Accessibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
The react charting library is accessibility MAS C compliant.
We satisfy accessibility requirements for the following aspects (and more).

- Screen readers and narrators in different browser modes.
- 400% browser zoom.
- Color contrast ratios.
- Keyboard navigation.
- Voice access.
- Supporting high contrast mode.
- Focusable elements
- ... and more

Browser modes:
Focus mode

All the colors in our palette meet accessibility requirements.
- They satisfy 4.5:1 contrast ratio with the background.
- They also meet the 3:1 contrast ratio wrt each other.
Loading

0 comments on commit e9998fc

Please sign in to comment.