static-site-express is a simple Node.js based static-site generator that uses EJS and Markdown. You can deploy your static site to the Netlify cloud computing platform. Deploy, customize, and write your own blog.
Post updated on September 13, 2019 Current version: 4.1.0
You have to options:
a) Clone my repository:
git clone https://github.com/SalsaBoy990/static-site-express name-of-your-site
b) Use the 'Deploy to Netlify' button on the example website
Build your site locally
a) Build site from
npm run build
b) Serve website on
npm run serve
c) Or you can watch for changes and trigger re-build with nodemon:
npm run watch
You need to add
sudo before the commands on Linux system.
nodemonnot trigger re-build on Linux on file changes (this behavior was experienced on Ubuntu 18.04 LTS Bionic Beaver)
- On Ubuntu, you can run
npm run watch-expcommand which uses the chokidar package. Experimental!
package.json for more info. The
site.config.js file contains some of the site properties (like site title, author, description, social media links etc.) that are used in the EJS partials.
Register at Netlify and publish your website
netlify.tomlconfiguration file contains important properties:
[build] base = "/" publish = "public" command = "npm run build"
The base path, the build command, and the publish directory. You can keep those settings.
_headers file you can specify the HTTP headers and set Content Security Policy (CSP) rules for the Netlify server. Currently, CSP rules are not set because I don't know which domains you want to whitelist when you create your own website. I recommend you the CSP Evaluator by Google.
_redirects file is currently empty. When you have a custom domain, you can make a redirect from *.netlify.com to your custom domain.
sitemap.xml is self-explanatory. Empty by default.
robots.txt is for search engines. Default settings:
# Disallow admin page User-agent: * Disallow: /admin/ # Disallow message-sent page User-agent: * Disallow: /message-sent/ # Rule 3 User-agent: * Allow: /
For Google Search Console verification, you should have an HTML file from Google included in the root of your Netlify publish folder (in our case, public). The build script copies this file from
./public. Change line 87 in
ssg.copyRootFile('FILENAME.html', srcPath, distPath)
Alternatively, you can use the Express server app on Heroku (not recommended)
Procfile is already supplied for you with the command to build the site, and after that, to run the app server:
web: npm run heroku
You need improve security! I already set security headers with the
helmet npm package, just 2 lines:
// Set Security Headers. const helmet = require('helmet') app.use(helmet())
Also, you can set Content Security Policy (CSP) rules using the
Keep in mind that the contact form on the example site only works on Netlify!!
If you have a problem or a question about static-site-express, open an issue here.
PS. The idea of making a static site generator in Node.js came from this good article by Douglas Matoso: Build a static site generator in 40 lines with Node.js.