Skip to content
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.

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

[docs] Improve documentation #287

Merged
merged 3 commits into from
Sep 16, 2020
Merged
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
14 changes: 0 additions & 14 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
const path = require('path');

const errorCodesPath = path.resolve(__dirname, './docs/public/static/error-codes.json');
const missingError = process.env.MUI_EXTRACT_ERROR_CODES === 'true' ? 'write' : 'annotate';

let defaultPresets;

// We release a ES version of Material-UI.
Expand Down Expand Up @@ -33,15 +28,6 @@ const defaultAlias = {
module.exports = {
presets: defaultPresets.concat(['@babel/preset-react', '@babel/preset-typescript']),
plugins: [
[
'babel-plugin-macros',
{
muiError: {
errorCodesPath,
missingError,
},
},
],
'babel-plugin-optimize-clsx',
['@babel/plugin-proposal-class-properties', { loose: true }],
['@babel/plugin-proposal-object-rest-spread', { loose: true }],
Expand Down
16 changes: 9 additions & 7 deletions docs/babel.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
const bpmr = require('babel-plugin-module-resolver');
const fse = require('fs-extra');
const path = require('path');

const errorCodesPath = path.resolve(__dirname, './public/static/error-codes.json');

function resolvePath(sourcePath, currentFile, opts) {
if (sourcePath === 'markdown') {
Expand All @@ -19,6 +16,11 @@ const alias = {
'@material-ui/x-grid-modules': '../packages/grid/x-grid-modules/src',
'@material-ui/x-grid': '../packages/grid/x-grid/src',
'@material-ui/x-license': '../packages/x-license/src',
// Help in the event npm and git are significantly desynchronized.
'@material-ui/core': './node_modules/@material-ui/monorepo/packages/material-ui/src',
'@material-ui/styles': './node_modules/@material-ui/monorepo/packages/material-ui-styles/src',
'@material-ui/docs': './node_modules/@material-ui/monorepo/packages/material-ui-docs/src',
'@material-ui/lab': './node_modules/@material-ui/monorepo/packages/material-ui-lab/src',
docs: './node_modules/@material-ui/monorepo/docs',
docsx: './',
modules: './node_modules/@material-ui/monorepo/modules',
Expand All @@ -35,11 +37,11 @@ module.exports = {
],
plugins: [
[
'babel-plugin-macros',
'babel-plugin-transform-rename-import',
{
muiError: {
errorCodesPath,
},
replacements: [
{ original: '@material-ui/utils/macros/MuiError.macro', replacement: 'react' },
],
},
],
'babel-plugin-optimize-clsx',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The data grid comes in 2 versions:

The features only available in the commercial version are suffixed with a <span style="font-size: 26px" role="img" title="Enterprise">⚡️</span> icon.

<img src="/static/x/header-icon.png" width="454" height="239" alt="">
<img src="/static/x/header-icon.png" style="width: 454px;" alt="">

### Try XGrid for free

Expand All @@ -120,19 +120,16 @@ Please take the component for a test run, no need to contact us.

If you have an enterprise grid running with an expired or missing license key the grid displays a watermark, and a warning is shown in the console.

<img src="/static/x/watermark.png" width="658" height="175" alt="">
<br />
<br />
<br />
<img src="/static/x/watermark.png" style="width: 658px; margin-bottom: 3rem" alt="">

See [Pricing](https://material-ui.com/store/items/material-ui-x/) for details on purchasing licenses.

### Feature comparison

The following table summarizes the features available in the community `DataGrid` and enterprise `XGrid` components. All the features of the community version are available in the enterprise one.

| | Community | Enterprise ⚡️ |
| --------------------------------------------------------------------------------------- | --------- | -------------- |
| Features | Community | Enterprise ⚡️ |
| :-------------------------------------------------------------------------------------- | --------- | -------------- |
| **Column** | | |
| [Column resizing](/components/data-grid/columns/#column-resizing) | ❌ | ✅ |
| [Column groups](/components/data-grid/columns/#column-groups) | 🚧 | 🚧 |
Expand Down
43 changes: 0 additions & 43 deletions docs/src/pages/landing/Pro.js

This file was deleted.

68 changes: 0 additions & 68 deletions docs/src/pages/landing/QuickWord.js

This file was deleted.

Loading