Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public/scripts
public/styles
public/images/global-shared
src/components/global
eslint.config.mjs

# general
apple-touch-*.png
Expand Down
893 changes: 0 additions & 893 deletions .yarn/releases/yarn-4.1.1.cjs

This file was deleted.

942 changes: 942 additions & 0 deletions .yarn/releases/yarn-4.10.3.cjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .yarnrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ checksumBehavior: update

nodeLinker: node-modules

yarnPath: .yarn/releases/yarn-4.1.1.cjs
yarnPath: .yarn/releases/yarn-4.10.3.cjs
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,19 +110,11 @@ The following VS Code extensions are recommended to get the best development exp

## Understanding Astro

The [Chocolatey Design System](https://design.chocolatey.org) and [choco-astro](https://github.com/chocolatey/choco-astro) contain information on how to understand several Astro concepts:

* Learn how to [override automatically generated heading ID's](https://github.com/chocolatey/choco-astro?tab=readme-ov-file#overriding-automatically-generated-heading-ids).
* Learn about Astro and how to use [Components in `.mdx` and `.astro`](https://design.chocolatey.org/foundations/astro) file types.
* Learn how to use the [`<Callout />` Component](https://design.chocolatey.org/components/callouts) to display notes and important information.
* Learn how to use the [`<CollapseButton />` Component](https://design.chocolatey.org/collapse-button) to display a button that triggers a collapsed element.
* Learn how to use the [`<Iframe />` Component](https://design.chocolatey.org/components/iframe) to display videos with defined aspect ratios.
* Learn how to use the [`<Tabs />` Component](https://design.chocolatey.org/components/tabs) to display content in tabbed interface.
* Learn how to use the [`<Xref />` Component](https://design.chocolatey.org/components/xref) to link to other documents within this repository.
The [Chocolatey Design System](https://design.chocolatey.org) and [@chocolatey-software/astro](https://github.com/chocolatey/choco-theme/packages/astro) contain information on how to understand several Astro concepts.

## Markdown Diagrams with Mermaid

[Mermaid](https://mermaid.js.org/) via an [Astro integration](https://github.com/chocolatey/choco-astro/blob/main/astro.config.mjs.json) allows an easy way to display information with diagrams written in markdown. Find more information on usage at the [choco-astro repository](https://github.com/chocolatey/choco-astro?tab=readme-ov-file#markdown-diagrams-with-mermaid).
[Mermaid](https://mermaid.js.org/) allows an easy way to display information with diagrams written in markdown. Find more information on usage at the [chocolatey-software/astro repository](https://github.com/chocolatey/choco-theme/packages/astro#markdown-diagrams-with-mermaid).

## Adding A New Highlight

Expand Down
10 changes: 5 additions & 5 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { defineConfig } from 'astro/config';
import sitemap from "@astrojs/sitemap";
import mdx from "@astrojs/mdx";
import sitemap from '@astrojs/sitemap';
import mdx from '@astrojs/mdx';
import rehypeMermaid from 'rehype-mermaid';
import remarkCustomHeaderId from 'remark-custom-header-id';
import { mermaidConfig } from 'choco-astro/src/scripts/util/mermaid-config';
import { mermaidConfig } from '@chocolatey-software/astro/src/scripts/util/mermaid-config';

export default defineConfig({
site: 'https://docs.chocolatey.org',
Expand All @@ -23,7 +23,7 @@ export default defineConfig({
],
rehypePlugins: [
[rehypeMermaid, {
mermaidConfig: mermaidConfig
mermaidConfig
}]
]
},
Expand Down Expand Up @@ -354,4 +354,4 @@ export default defineConfig({
'/en-us/create/functions/test-processadminrights': '/en-us/create/cmdlets/test-processadminrights/',
'/en-us/create/functions/update-sessionenvironment': '/en-us/create/cmdlets/update-sessionenvironment/',
}
});
});
19 changes: 13 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docs",
"packageManager": "yarn@4.1.1",
"packageManager": "yarn@4.10.3",
"repository": {
"type": "git",
"url": "git+https://github.com/chocolatey/docs.git"
Expand All @@ -17,18 +17,25 @@
"astro": "npx astro",
"browsers": "npx playwright install --with-deps",
"build": "yarn dependencies && yarn telemetry && yarn choco-theme && yarn browsers && npx astro check && npx astro build",
"build-copy-theme": "npx tsx node_modules/@chocolatey-software/build-tools/build/copy-theme.ts docs",
"build-purge-css": "npx tsx node_modules/@chocolatey-software/build-tools/build/purge-css.ts docs",
"build-copy-playwright": "npx tsx node_modules/@chocolatey-software/build-tools/build/copy-playwright.ts docs",
"dependencies": "yarn install --immutable",
"dev": "yarn dependencies && yarn telemetry && yarn choco-theme && yarn browsers && npx astro dev",
"playwright": "npx playwright test",
"playwright-copy": "node node_modules/choco-playwright/build/copy-playwright.js",
"preview": "npx astro preview",
"start": "yarn dev",
"telemetry": "npx astro telemetry disable",
"choco-theme": "npx --quiet ts-node --skipIgnore node_modules/choco-theme/build/choco-theme.ts --repository=docs && yarn playwright-copy"
"choco-theme": "yarn build-copy-theme && yarn build-copy-playwright && yarn build-purge-css",
"link-packages": "npx tsx node_modules/@chocolatey-software/build-tools/build/link.ts"
},
"devDependencies": {
"@chocolatey-software/assets": "2.0.0",
"@chocolatey-software/astro": "2.0.0",
"@chocolatey-software/build-tools": "2.0.0",
"@chocolatey-software/playwright": "2.0.0"
},
"dependencies": {
"choco-astro": "0.3.2",
"choco-playwright": "0.1.0",
"choco-theme": "1.3.0"
"@chocolatey-software/docs": "2.0.0"
}
}
15 changes: 7 additions & 8 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
{
"extends": "astro/tsconfigs/strict",
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@choco-astro/components/*": ["node_modules/choco-astro/src/components/*"],
"@choco-playwright/*": ["playwright/global/*"],
"@content/*": ["src/content/*"],
"@components/*": ["src/components/*"],
"@layouts/*": ["src/layouts/*"],
"@choco-astro/components/*": ["./node_modules/@chocolatey-software/astro/src/components/*"],
"@choco-playwright/*": ["./playwright/global/*"],
"@content/*": ["./src/content/*"],
"@components/*": ["./src/components/*"],
"@layouts/*": ["./src/layouts/*"],
"@root/*": ["./*"],
"@styles/*": ["src/styles/*"],
"@scripts/*": ["src/scripts/*"]
"@styles/*": ["./src/styles/*"],
"@scripts/*": ["./src/scripts/*"]
}
}
}
Loading