The static template generator is a tool designed to help with the creation of static templates for client projects.
This was created with 11ty, a very simple static site generator. Additional documentation can be found on the 11ty website. Assets are compiled with Laravel Mix and styles are built with Tailwind.
The dependencies have been acquired through Yarn. Therefore, to get started you will need to install the project dependencies with the following command:
yarn install
Run the local web server and compile assets locally
yarn devBuild the project for production
yarn prodLint code (at the moment, scss only)
yarn lintLaravel Mix is responsible for bundling assets, such as CSS and JS.
Feel free modify the configuration file as you see fit. Additional API information can be retrieved on the Mix Documentation
This starter kit has been developed with the ability to create Netlify Functions for serverless tasks. To develop functions locally, we would advise using Netlify's CLI tool.
Start by installing the cli tool globally:
$ npm i netlify-cli -g
Once installed, simply run:
$ netlify dev
Netlify Dev should take care of everything from there, however, if you experience any issues please raise this with the team or raise an issue in Github.
Say you're building a site with this starter, but you still want to be able to pull in the latest changes, you can add a remote upstream pointing to this repository.
- Navigate to your local theme folder.
- Verify the list of remotes and validate that you have both an origin and upstream:
git remote -v
- If you don't see an upstream, you can add one that points to the Artemis starter repository:
git remote add upstream https://github.com/StackUp-Digital/Artemis-11ty-Starter-Tailwind.git
- Pull the latest changes into your repository:
git fetch upstream
git pull upstream main
If you have any issues getting started or feel like the documentation is missing some information then please feel free to raise an issue against this repository.