Premail.dev website

This is the repository for https://premail.dev website. If you're looking for the premail code itself, visit https://github.com/premail/premail/.

The Premail website is built using Docusaurus 2, a modern static website generator. Code is hosted in the main branch, and the rendered site in gh-pages, where it is unsurprisingly hosted on GitHub Pages.

Changes to the main branch trigger the website to be rebuilt and deployed automatically.

Development

Prerequisites

Node >= 14.x (which can be checked by running node -v). Notepremail itself uses Node 12.x; we recommend using n or nvm if you're managing multiple versions of Node.
Yarn version >= 1.5 (which can be checked by running yarn --version). Yarn is a performant package manager for JavaScript and replaces the npm client. It is not strictly necessary but highly encouraged.

Installation

yarn

Watch

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Test build

yarn build

This command generates static content into the build directory. It's generally unnecessary to run this locally, since it's run automatically during deployment, but if issues arise this will show you exactly what Docusaurus is creating.

Deployment

🢧 Merge a PR or push changes to the main branch and the website will be automatically rebuilt and deployed.

You can also deploy manually with:

GIT_USER=<username> USE_SSH=true yarn deploy

License

Premail.dev is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Premail itself is licensed under the GNU Affero General Public License v3.0 or later. To be clear: This license only covers Premail, not any content you generate using Premail. Those files are yours to do with as you wish, and you need not share them, much less license them, in any particular way.

For the legal details of the AGPL, see the complete LICENSE.

premail/website