sp-dev-fx-webparts/samples/js-extend-webpack
Hugo Bernier 810a68ebee Updated contributors for readmes 2023-03-15 00:11:27 -04:00
..
.devcontainer added remaining containers 2022-02-16 21:47:07 -05:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config Updating the "Extend Webpack" example to correspond to the edits to the documentation. (#332) 2017-10-13 09:32:54 -04:00
src Updating the "Extend Webpack" example to correspond to the edits to the documentation. (#332) 2017-10-13 09:32:54 -04:00
.editorconfig Webpack extension sample. 2017-01-25 22:18:17 -08:00
.gitattributes Webpack extension sample. 2017-01-25 22:18:17 -08:00
.gitignore Webpack extension sample. 2017-01-25 22:18:17 -08:00
.npmignore Webpack extension sample. 2017-01-25 22:18:17 -08:00
.yo-rc.json Webpack extension sample. 2017-01-25 22:18:17 -08:00
README.md Updated contributors for readmes 2023-03-15 00:11:27 -04:00
gulpfile.js Updating the "Extend Webpack" example to correspond to the edits to the documentation. (#332) 2017-10-13 09:32:54 -04:00
package.json Updating the "Extend Webpack" example to correspond to the edits to the documentation. (#332) 2017-10-13 09:32:54 -04:00
tsconfig.json `js-extend-webpack` sample updated to GA (#257) 2017-07-21 20:54:47 +03:00
tslint.json Add tslint at the root of each SPFx project (#394) 2018-01-08 15:58:48 +02:00
yarn.lock Bump ua-parser-js from 0.7.28 to 0.7.33 in /samples/js-extend-webpack 2023-01-31 10:05:58 -05:00

README.md

page_type products languages extensions
sample
office-sp
javascript
typescript
contentType technologies createdDate
tools
SharePoint Framework
1/1/2016 12:00:00 AM

Extending webpack in the SharePoint Framework toolchain

Summary

Webpack is a JavaScript module bundler that takes your JavaScript files and its dependencies and generates one or more JavaScript bundles so you can load different bundles for different scenarios.

One common task you would want to add to the SharePoint Framework toolchain is to extend the webpack configuration with custom loaders and plugins.

This sample shows how to use the webpack markdown-loader to preprocess markdown files to HTML string.

Read the following documentation for detailed information on working with webpack loaders in SharePoint Framework:

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 1.3.0 Node.js v6 Compatible with SharePoint Online Compatible SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Contributors

Version history

Version Date Comments
1.0 January 25th, 2017 Initial release
1.1 July 9th, 2017 Updated to GA Version

Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • npm install
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.