#HOW TO RUN WEBPACK ON GITHUB PAGES HOW TO#
#HOW TO RUN WEBPACK ON GITHUB PAGES GENERATOR#

You can now run a build of your documentation using: jekyll build However, when using a custom domain you'll need to use /dist/ instead. If you're not using a custom domain name for your project, you can use //dist/ in order to get the absolute URI to your compiled assets. For this demonstration, I've used a relative path to the dist folder. In the manifest plugin configuration you can specify from where the assets are loaded from by setting the publicPath option. You do this by creating a file: const purgecss = [ДefaultExtractor: content => content.match(/+(? To build your styles, you'll need to setup the Tailwind CSS plugin for PostCSS. The entrypoint points to assets/index.css, which will contain the imports of tailwind's utilities and base styles. The old build artefacts are removed by the clean-webpack-plugin plugin, keeping our /dist/ folder nice and clean. The webpack-manifest-plugin will generate a JSON file, which contains a lookup table for our assets. This configuration ensures that CSS is extracted from the output and stored in its own file using the mini-css-extract-plugin package. Hmr: _ENV = 'development',ДЇilename: isProduction ? '.css' : '.css' Path: path.resolve(_dirname, './dist/'),ДЇilename: isProduction ? '.js' : '.js',Д¬hunkFilename: isProduction ? '.js' : '.js', Mode: isProduction ? 'production' : 'development',Дocs: path.resolve(_dirname, './assets/index.css'), 'installing some NPM dependencies'.ДЇirst, setup a private package.json: echo ' = require('clean-webpack-plugin') Let's start by downloading half the internet a.k.a. Great!Now that you have this done webpack configuration. In order to preview our website, run jekyll serve and visit localhost:4000. For the default layout ( _layouts/default.html), use: It also specifies the default name for our layout. It also contains the assets directory, which is where the generated CSS files will be placed later. This includes the node_modules direction, some configuration files, both package.json files (normal + lock). This configuration file will make sure any unwanted files and directories are not published. Once Jekyll is installed, you can configure it by creating a file named _config.yml in the root of the Jekyll project: defaults:

#HOW TO RUN WEBPACK ON GITHUB PAGES HOW TO#

That requires running Jekyll locally, and the docs for Jekyll show you how to install it on your machine. Whenever I work on documentation sites, I like to preview them locally, so that I have a quick feedback loop for whatever changes I'm making. The next part will all take place in the docs folder. Adding this file makes sure the /docs/ directory exists in our repository and allows us to select it as the source of our documentation.Д®nable the docs by choosing the following option in your settings page: Note the creation of the docs directory with a placeholder file named. You can find the options to enable the publication of your website in your repository settings page. You need an initial branch to set up GitHub Pages. Git remote add origin push -u origin master echo '# tailwind-docs-example' > README.md Be sure to replace the git URL with your own repository URL. To quickly setup an example repository and add a README.md, use the following commands. If anything, it was always a constant reminder for me to keep them up to date. In my experience, it keeps the docs from being neglected. When creating pull requests, you can add the documentation for new features. Using GitHub Pages is great because you're able to have documentation and implementation side by side. I use Tailwind CSS because it's awesome.I try to deliver the smallest amount of CSS.I ensure CSS and JS files have proper cache-busting.I use Jekyll because it simplifies the writing process.When setting up documentation websites I tend to do many things the same way for every project.

In this post, I'll share how I set up the documentation websites for EventSauce and Flysystem, and hope it'll inspire you to do something similar for your project. The docs for Symfony have improved a lot over the years as well. For example, the docs for Laravel and Tailwind CSS are really nice. The ones I like the best are the ones that seem handcrafted. It's a great marketing tool for you as an individual developer or your company. I've used these tools to create the documentation websites for Flysystem and EventSauce.ДЄ good documentation website helps you grow your user base.

#HOW TO RUN WEBPACK ON GITHUB PAGES GENERATOR#

When paired with a static site generator like Jekyll you've got all the tools to build a custom documentation website for your open source project. The library has taken the world by storm, and that doesn't surprise me one bit.

It's quick, it's easy, and it gets the job done well. To me, Tailwind CSS is one of the the most enjoyable tools to build documentation websites.

How to run webpack on github pages