330 lines
17 KiB
HTML
330 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta http-equiv="X-UA-Compatible" content="ie=edge">
|
|
<link rel="stylesheet" href="../../static/styles.css?h=ca3aba42">
|
|
<link rel="stylesheet" href="../../static/pygments.css">
|
|
<link rel="shortcut icon" href="../../static/favicon.png?h=fa09bedd">
|
|
<title> | Lektor Static Content Management System</title>
|
|
</head>
|
|
<body class="default">
|
|
<nav class="navbar navbar-inverse navbar-static-top">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed"
|
|
data-toggle="collapse" data-target="#navbar"
|
|
aria-expanded="false" aria-controls="navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a class="navbar-brand" href="../../">Lektor</a>
|
|
</div>
|
|
<div id="navbar" class="collapse navbar-collapse">
|
|
<ul class="nav navbar-nav">
|
|
|
|
<li><a href="../../downloads/">Download</a></li>
|
|
|
|
<li><a href="../../docs/">Documentation</a></li>
|
|
|
|
<li><a href="../../showcase/">Showcase</a></li>
|
|
|
|
<li class="active"><a href="../">Plugins</a></li>
|
|
|
|
<li><a href="../../community/">Community</a></li>
|
|
|
|
<li><a href="../../blog/">Blog</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="body-wrapper">
|
|
|
|
|
|
|
|
<div class="page-banner page-banner-300" style="background-image: url(../header.jpg)"></div>
|
|
|
|
|
|
<div class="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Place this tag in your head or just before your close body tag. -->
|
|
|
|
<div class="plugin">
|
|
<div class="row">
|
|
<div class="col-sm-12">
|
|
<h1>Plugin – lektor-webpack-support 0.6.0</h1>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="row">
|
|
<div class="col-sm-1"></div>
|
|
<div class="col-sm-11">
|
|
<p>Super simple Lektor plugin that runs a webpack watcher<p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="row">
|
|
<div class="col-sm-3 plugin-margin">
|
|
<h4>Project links</h4>
|
|
<ul class="tree-nav">
|
|
<li><a href="https://github.com/lektor/lektor-webpack-support" class="ext">Homepage</a></li>
|
|
</ul>
|
|
|
|
|
|
<div class="separator">
|
|
<h4>GitHub Statistics</h4>
|
|
</div>
|
|
<ul class="button-nav">
|
|
<li><p><a class="github-button" href="https://github.com/lektor/lektor-webpack-support" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star lektor-webpack-support on GitHub" target="_blank">Star</a></p></li>
|
|
<li><p><a class="github-button" href="https://github.com/lektor/lektor-webpack-support/fork" data-icon="octicon-repo-forked" data-show-count="true" data-size="large" data-show="true" aria-label="Open Issues" target="_blank">Fork</a></p></li>
|
|
<li><p><a class="github-button" href="https://github.com/lektor/lektor-webpack-support/issues" data-icon="octicon-issue-opened" data-show-count="true" data-size="large" data-show="true" aria-label="Open Issues" target="_blank">Open Issues</a></p></li>
|
|
</ul>
|
|
|
|
|
|
<div class="separator">
|
|
<h4>Meta</h4>
|
|
</div>
|
|
<p><strong>Version:</strong> 0.6.0</p>
|
|
<p><strong>Author:</strong>
|
|
|
|
<a href = "mailto:armin.ronacher@active-4.com">Armin Ronacher</a>
|
|
|
|
</p>
|
|
|
|
|
|
<div class="separator">
|
|
<h4>Tags</h4>
|
|
</div>
|
|
|
|
|
|
|
|
<a href="../tag/before-build-all/">before-build-all</a>,
|
|
|
|
|
|
<a href="../tag/Node/">Node</a>,
|
|
|
|
|
|
<a href="../tag/npm/">npm</a>,
|
|
|
|
|
|
<a href="../tag/official/">official</a>,
|
|
|
|
|
|
<a href="../tag/SCSS/">SCSS</a>,
|
|
|
|
|
|
<a href="../tag/server-spawn/">server-spawn</a>,
|
|
|
|
|
|
<a href="../tag/server-stop/">server-stop</a>,
|
|
|
|
|
|
<a href="../tag/webpack/">webpack</a>,
|
|
|
|
and
|
|
<a href="../tag/Yarn/">Yarn</a>
|
|
|
|
|
|
<p>View <a href="/plugins/tags" class="ref">all tags</a>.</p>
|
|
</div>
|
|
|
|
<div class="col-sm-9 doc-styling">
|
|
<h2>Project Description</h2>
|
|
|
|
<h1>lektor-webpack-support</h1>
|
|
<p>This is a plugin for Lektor that adds support for webpack to projects. When
|
|
enabled it can build a webpack project from the <code>webpack/</code> folder into the
|
|
asset folder automatically when the server (or build process) is run with
|
|
the <code>-f webpack</code> flag.</p>
|
|
<h2>Enabling the Plugin</h2>
|
|
<p>To enable the plugin add this to your project file, run this command while
|
|
sitting in your Lektor project directory:</p>
|
|
<pre>lektor plugins add lektor-webpack-support
|
|
</pre>
|
|
<h2>Creating a Webpack Project</h2>
|
|
<p>Next you need to create a webpack project. Create a <code>webpack/</code> folder and
|
|
inside that folder create <code>package.json</code> and a <code>webpack.config.js</code></p>
|
|
<h3><code>webpack/package.json</code></h3>
|
|
<p>This file instructs <code>npm</code> which packages we will need. All we need for a
|
|
start is to create an almost empty file (name and version fields are mandatory
|
|
but not important for functionality, change them to suit your own needs):</p>
|
|
<pre><span class="p">{</span><span class="w"></span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lektor-webpack"</span><span class="p">,</span><span class="w"></span>
|
|
<span class="w"> </span><span class="nt">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.0.0"</span><span class="p">,</span><span class="w"></span>
|
|
<span class="w"> </span><span class="nt">"private"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"></span>
|
|
<span class="p">}</span><span class="w"></span>
|
|
</pre>
|
|
<p>Now we can <code>npm install</code> (or <code>yarn add</code>) the rest:</p>
|
|
<pre><code>$ cd </path/to/your/lektor/project>/webpack
|
|
$ npm install --save-dev webpack webpack-cli @babel/core sass babel-loader sass-loader css-loader url-loader file-loader mini-css-extract-plugin
|
|
</code></pre>
|
|
<p>This will install webpack itself together with babel and sass as well as
|
|
a bunch of loaders we need for getting all that configured. Because we
|
|
created a <code>package.json</code> before and we use <code>--save-dev</code> the dependencies
|
|
will be remembered in the <code>package.json</code> file.</p>
|
|
<h3><code>webpack/webpack.config.js</code></h3>
|
|
<p>Next up is the webpack config file. Here we will go with a very basic
|
|
setup that's good enough to cover most things you will encounter. The
|
|
idea is to build the files from <code>webpack/scss</code> and <code>webpack/js</code> into
|
|
<code>assets/static/gen</code> so that we can use it even if we do not have webpack
|
|
installed for as long as someone else ran it before.</p>
|
|
<pre><span class="kd">const</span> <span class="nx">path</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">"path"</span><span class="p">);</span>
|
|
<span class="kd">const</span> <span class="nx">MiniCssExtractPlugin</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">"mini-css-extract-plugin"</span><span class="p">);</span>
|
|
|
|
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="nx">entry</span><span class="o">:</span> <span class="p">{</span>
|
|
<span class="nx">app</span><span class="o">:</span> <span class="s2">"./js/main.js"</span><span class="p">,</span>
|
|
<span class="nx">styles</span><span class="o">:</span> <span class="s2">"./scss/main.scss"</span><span class="p">,</span>
|
|
<span class="p">},</span>
|
|
<span class="nx">output</span><span class="o">:</span> <span class="p">{</span>
|
|
<span class="nx">path</span><span class="o">:</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">path</span><span class="p">.</span><span class="nx">dirname</span><span class="p">(</span><span class="nx">__dirname</span><span class="p">),</span> <span class="s2">"assets"</span><span class="p">,</span> <span class="s2">"static"</span><span class="p">,</span> <span class="s2">"gen"</span><span class="p">),</span>
|
|
<span class="nx">filename</span><span class="o">:</span> <span class="s2">"[name].js"</span><span class="p">,</span>
|
|
<span class="p">},</span>
|
|
<span class="nx">devtool</span><span class="o">:</span> <span class="s2">"source-map"</span><span class="p">,</span>
|
|
<span class="nx">mode</span><span class="o">:</span> <span class="s2">"production"</span><span class="p">,</span>
|
|
<span class="nx">module</span><span class="o">:</span> <span class="p">{</span>
|
|
<span class="nx">rules</span><span class="o">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="nx">test</span><span class="o">:</span> <span class="sr">/\.js$/</span><span class="p">,</span>
|
|
<span class="nx">exclude</span><span class="o">:</span> <span class="sr">/node_modules/</span><span class="p">,</span>
|
|
<span class="nx">use</span><span class="o">:</span> <span class="p">[</span><span class="s2">"babel-loader"</span><span class="p">],</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="nx">test</span><span class="o">:</span> <span class="sr">/\.scss$/</span><span class="p">,</span>
|
|
<span class="nx">use</span><span class="o">:</span> <span class="p">[</span><span class="nx">MiniCssExtractPlugin</span><span class="p">.</span><span class="nx">loader</span><span class="p">,</span> <span class="s2">"css-loader"</span><span class="p">,</span> <span class="s2">"sass-loader"</span><span class="p">],</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="nx">test</span><span class="o">:</span> <span class="sr">/\.css$/</span><span class="p">,</span>
|
|
<span class="nx">use</span><span class="o">:</span> <span class="p">[</span><span class="nx">MiniCssExtractPlugin</span><span class="p">.</span><span class="nx">loader</span><span class="p">,</span> <span class="s2">"css-loader"</span><span class="p">],</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="nx">test</span><span class="o">:</span> <span class="sr">/\.(woff2?|ttf|eot|svg|png|jpe?g|gif)$/</span><span class="p">,</span>
|
|
<span class="nx">use</span><span class="o">:</span> <span class="p">[</span><span class="s2">"file"</span><span class="p">],</span>
|
|
<span class="p">},</span>
|
|
<span class="p">],</span>
|
|
<span class="p">},</span>
|
|
<span class="nx">plugins</span><span class="o">:</span> <span class="p">[</span><span class="ow">new</span> <span class="nx">MiniCssExtractPlugin</span><span class="p">({</span> <span class="nx">filename</span><span class="o">:</span> <span class="s2">"styles.css"</span> <span class="p">})],</span>
|
|
<span class="p">};</span>
|
|
</pre>
|
|
<h2>Creating the App</h2>
|
|
<p>Now we can start building our app. We configured at least two files
|
|
in webpack: <code>js/main.js</code> and <code>scss/main.scss</code>. Those are the entry
|
|
points we need to have. You can create them as empty files in
|
|
<code>webpack/js/main.js</code> and <code>webpack/scss/main.scss</code>.</p>
|
|
<h2>Running the Server</h2>
|
|
<p>Now you're ready to go. When you run <code>lektor server</code> webpack will not
|
|
run, instead you need to now run it as <code>lektor server -f webpack</code> which
|
|
will enable the webpack build. Webpack automatically builds your files
|
|
into <code>assets/static/gen</code> and this is where Lektor will then pick up the
|
|
files. This is done so that you can ship the webpack generated assets
|
|
to others that do not have webpack installed which simplifies using a
|
|
Lektor website that uses webpack.</p>
|
|
<h2>Manual Builds</h2>
|
|
<p>To manually trigger a build that also invokes webpack you can use
|
|
<code>lektor build -f webpack</code>.</p>
|
|
<h2>Including The Files</h2>
|
|
<p>Now you need to include the files in your template. This will do it:</p>
|
|
<pre><span class="p"><</span><span class="nt">link</span> <span class="na">rel</span><span class="o">=</span><span class="s">"stylesheet"</span> <span class="na">href</span><span class="o">=</span><span class="s">"{{ '/static/gen/styles.css'|asseturl }}"</span><span class="p">></span>
|
|
<span class="p"><</span><span class="nt">script</span> <span class="na">type</span><span class="o">=</span><span class="s">text/javascript</span> <span class="na">src</span><span class="o">=</span><span class="s">"{{ '/static/gen/app.js'|asseturl }}"</span> <span class="na">charset</span><span class="o">=</span><span class="s">"utf-8"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<div class="comment-box">
|
|
<h2>Comments</h2>
|
|
|
|
<div id="disqus_thread"></div>
|
|
<script>
|
|
var disqus_config = function() { this.page.identifier = "/plugins/lektor-webpack-support"; this.page.url = "https://www.getlektor.com/plugins/lektor-webpack-support/"; };
|
|
(function() {
|
|
var d = document, s = d.createElement('script');
|
|
s.src = '//lektordocumentation.disqus.com/embed.js';
|
|
s.setAttribute('data-timestamp', +new Date());
|
|
(d.head || d.body).appendChild(s);
|
|
})();
|
|
</script>
|
|
<noscript>
|
|
Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript"
|
|
rel="nofollow">comments powered by Disqus.</a>
|
|
</noscript>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="bottomsummary">
|
|
<div class="container">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<footer>
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-sm-4 icon-bar">
|
|
<a href="https://github.com/lektor/lektor/" title="Lektor on GitHub"
|
|
><i class="fa fa-github"></i></a>
|
|
<a href="https://github.com/lektor/lektor/issues/" title="Report Issues for Lektor"
|
|
><i class="fa fa-bug"></i></a>
|
|
<a href="https://twitter.com/getlektor" title="Find Lektor on Twitter"
|
|
><i class="fa fa-twitter"></i></a>
|
|
<a href="https://gitter.im/lektor/lektor" title="Chat on Gitter"
|
|
><i class="fa fa-comment"></i></a>
|
|
<a href="https://github.com/lektor/lektor-website/tree/master/content/plugins/lektor-webpack-support/contents.lr" title="View source for this page"><i class="fa fa-code"></i></a>
|
|
</div>
|
|
<div class="col-sm-8">
|
|
<a href="../../license/">License & Copyright</a> •
|
|
<a href="../../contact/">Contact</a> •
|
|
Made with <i class="fa fa-fw fa-heart" title="Heart"><span hidden>Heart</span></i> in Carinthia
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
|
|
<script type=text/javascript src="../../static/app.js?h=bb1b933a" charset="utf-8"></script>
|
|
<script>
|
|
((window.gitter = {}).chat = {}).options = {
|
|
room: 'lektor/lektor',
|
|
activationElement: null
|
|
};
|
|
document.write('<button class="js-gitter-toggle-chat-button">Toggle Chat</button>');
|
|
var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
|
|
if (dnt != "1" && dnt != "yes") {
|
|
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
|
|
ga('create', 'UA-70822533-1', 'auto');
|
|
ga('set', 'anonymizeIp', true);
|
|
ga('send', 'pageview');
|
|
} else {
|
|
console.debug("Respecting Do-Not-Track, not running analytics.");
|
|
}
|
|
</script>
|
|
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
|
<script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
|
|
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
|
|
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
|
|
</body>
|
|
</html>
|