Skip to content

updated getting started docs #7168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mvolkmann wants to merge 2 commits into
base: main
Choose a base branch
from
Open

updated getting started docs #7168

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca81657
updated getting started docs
mvolkmann Aug 20, 2025
b156eae
Merge branch 'main' into main
janechu Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion sites/website/src/pages/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export default function () {
<h3>Install the package</h3>
<CodeBlock>npm install @microsoft/fast-element</CodeBlock>

<h3>Create a web component</h3>
<h3>Create a web component in the file `hello-world.ts`</h3>
<CodeBlock language="typescript">
{`/*
* import utilities from @microsoft/fast-element
Expand Down Expand Up @@ -106,6 +106,20 @@ HelloWorld.define({
<CodeBlock language="html">
{`<hello-world name="Earth"></hello-world>`}
</CodeBlock>

<h3>Update your tsconfig.json file to support decorators</h3>
<CodeBlock language="json">
{{
"compilerOptions": {
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"module": "ESNext",
"moduleResolution": "bundler",
"target": "ES2020",
"useDefineForClassFields": false
}
}}
</CodeBlock>
</section>

<div role="separator" className="section-decoration"></div>
Expand Down