Skip to content

Commit 80ef59b

Browse files
authored
Update README.md (#7534)
1 parent e42d6a2 commit 80ef59b

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ This is not a mobile-first UI toolkit.
1111

1212
[**View the full documentation ▸**](http://blueprintjs.com/docs)
1313

14-
[**Try it out on CodeSandbox ▸**](https://codesandbox.io/p/sandbox/blueprint-v5-x-sandbox-react-16-wy0ojy)
14+
[**Try it out on CodeSandbox ▸**](https://codesandbox.io/p/sandbox/blueprint-v6-react-18-template-lc69nt)
1515

1616
[**Read frequently asked questions (FAQ) on the wiki ▸**](https://github.com/palantir/blueprint/wiki/Frequently-Asked-Questions)
1717

1818
## Changelog
1919

2020
Blueprint's change log and migration guides for major versions live on the repo's
21-
[Github wiki](https://github.com/palantir/blueprint/wiki/5.x-Changelog).
21+
[Github wiki](https://github.com/palantir/blueprint/wiki/6.x-Changelog).
2222

2323
## Packages
2424

@@ -31,9 +31,8 @@ These are the component libraries we publish to NPM.
3131
- [![npm](https://img.shields.io/npm/v/@blueprintjs/colors.svg?label=@blueprintjs/colors)](https://www.npmjs.com/package/@blueprintjs/colors) – Design system color variables.
3232
- [![npm](https://img.shields.io/npm/v/@blueprintjs/core.svg?label=@blueprintjs/core)](https://www.npmjs.com/package/@blueprintjs/core) – Core styles & components.
3333
- [![npm](https://img.shields.io/npm/v/@blueprintjs/datetime.svg?label=@blueprintjs/datetime)](https://www.npmjs.com/package/@blueprintjs/datetime) – Components for interacting with dates and times.
34-
- [![npm](https://img.shields.io/npm/v/@blueprintjs/datetime2.svg?label=@blueprintjs/datetime2)](https://www.npmjs.com/package/@blueprintjs/datetime2) – Next-generation components for interacting with dates and times.
3534
- [![npm](https://img.shields.io/npm/v/@blueprintjs/icons.svg?label=@blueprintjs/icons)](https://www.npmjs.com/package/@blueprintjs/icons) – APIs for displaying icons (contains both SVG and icon font implementations).
36-
- [![npm](https://img.shields.io/npm/v/@blueprintjs/monaco-editor-theme.svg?label=@blueprintjs/monaco-editor-theme)](https://www.npmjs.com/package/@blueprintjs/monaco-editor-theme) – Theme for [Monaco Editor](https://microsoft.github.io/monaco-editor/) (:warning: experimental).
35+
- [![npm](https://img.shields.io/npm/v/@blueprintjs/monaco-editor-theme.svg?label=@blueprintjs/monaco-editor-theme)](https://www.npmjs.com/package/@blueprintjs/monaco-editor-theme) – Theme for [Monaco Editor](https://microsoft.github.io/monaco-editor) (:warning: experimental).
3736
- [![npm](https://img.shields.io/npm/v/@blueprintjs/select.svg?label=@blueprintjs/select)](https://www.npmjs.com/package/@blueprintjs/select) – Components for selecting items from a list.
3837
- [![npm](https://img.shields.io/npm/v/@blueprintjs/table.svg?label=@blueprintjs/table)](https://www.npmjs.com/package/@blueprintjs/table) – Scalable & interactive spreadsheet-like table component.
3938

@@ -60,7 +59,6 @@ These packages define development dependencies and contain build configuration.
6059
- [![npm](https://img.shields.io/npm/v/@blueprintjs/node-build-scripts.svg?label=@blueprintjs/node-build-scripts)](https://www.npmjs.com/package/@blueprintjs/node-build-scripts) – various utility scripts for building Sass sources, linting Sass & TypeScript, generating Sass & Less variables, and optimizing icon SVGs.
6160
- [![npm](https://img.shields.io/npm/v/@blueprintjs/stylelint-plugin.svg?label=@blueprintjs/stylelint-plugin)](https://www.npmjs.com/package/@blueprintjs/stylelint-plugin) – implementations for custom stylelint rules which enforce best practices for Blueprint usage.
6261
- [![npm](https://img.shields.io/npm/v/@blueprintjs/test-commons.svg?label=@blueprintjs/test-commons)](https://www.npmjs.com/package/@blueprintjs/test-commons) – various utility functions used in Blueprint test suites.
63-
- [![npm](https://img.shields.io/npm/v/@blueprintjs/tslint-config.svg?label=@blueprintjs/tslint-config)](https://www.npmjs.com/package/@blueprintjs/tslint-config) – TSLint configuration used in this repo and recommended for Blueprint-related projects (should be installed by `@blueprintjs/eslint-config`, not directly).
6462
- [![npm](https://img.shields.io/npm/v/@blueprintjs/webpack-build-scripts.svg?label=@blueprintjs/webpack-build-scripts)](https://www.npmjs.com/package/@blueprintjs/webpack-build-scripts) – Webpack build configuration for Blueprint projects.
6563

6664
## Contributing
@@ -71,7 +69,7 @@ then [check out the "help wanted" label](https://github.com/palantir/blueprint/l
7169

7270
## Development
7371

74-
[Yarn](https://yarnpkg.com/) manages third-party and inter-package dependencies in this monorepo.
72+
[Yarn](https://yarnpkg.com) manages third-party and inter-package dependencies in this monorepo.
7573
Builds are orchestrated via [Nx's task runner](https://nx.dev/getting-started/intro) and NPM scripts.
7674
[Lerna-Lite](https://github.com/lerna-lite/lerna-lite) is used to prepare releases.
7775

@@ -122,7 +120,7 @@ There are a few ways to run development scripts, here they are listed from simpl
122120

123121
### Updating documentation
124122

125-
Much of Blueprint's documentation lives inside source code as JSDoc comments in `.tsx` files and KSS markup in `.scss` files. This documentation is extracted and converted into static JSON data using [documentalist](https://github.com/palantir/documentalist/). If you are updating documentation sources (_not_ the docs UI code which lives in `packages/docs-app` or the docs theme in `packages/docs-theme`), you'll need to run `yarn compile` from `packages/docs-data` to see changes reflected in the application. For simplicity, an alias script `yarn docs-data` exists in the root to minimize directory hopping.
123+
Much of Blueprint's documentation lives inside source code as JSDoc comments in `.tsx` files and KSS markup in `.scss` files. This documentation is extracted and converted into static JSON data using [documentalist](https://github.com/palantir/documentalist). If you are updating documentation sources (_not_ the docs UI code which lives in `packages/docs-app` or the docs theme in `packages/docs-theme`), you'll need to run `yarn compile` from `packages/docs-data` to see changes reflected in the application. For simplicity, an alias script `yarn docs-data` exists in the root to minimize directory hopping.
126124

127125
### Updating icons
128126

0 commit comments

Comments
 (0)