Currently, all easy-webpack modules do not have any documentation. This require users to check source code for each module's function and how to use it. I would like to help with documentation and improve easy-webpack.
Before starting, what should be included in documentation? I can think of the followings.
Short description on what the package can do
Installation, sample usage and output config
Description on each options
Related tutorials
Tips (if any)
@niieani
Take config-css as example. Here is the sample documentation.
Currently, all easy-webpack modules do not have any documentation. This require users to check source code for each module's function and how to use it. I would like to help with documentation and improve easy-webpack.
Before starting, what should be included in documentation? I can think of the followings.
@niieani
Take config-css as example. Here is the sample documentation.
@easy-webpack/config-css
Include and inject css using css-loader and style-loader
Installation
easy-webpack is also required.
Usage
On any JavaScript module, simply import your css file and it will be injected into the DOM globally.
Options
filename
Type:
String
Default:[name].css
Filename of the extracted css file. Only be used if
extractText
is notfalse
orundefined
.allChunks
(Other options)
Related tutorials
Tips
Add PostCSS to pipeline
PostCSS is a set of plugins that can transform your CSS.
To add PostCSS install postcss-loader first.
Then, (etc...)