Developing a DocPad website and deploying it to an Ubuntu server

UpdatedAugust 4, 2020

•2 min read•View as Markdown

Tina Holly

Hi, my name is Tina! I am a Full Stack Software Developer and Tech Lead from Canada. 🙋🏻‍♀️

Comments

Join the discussion

No comments yet. Be the first to comment.

More from this blog

Uninstalling a package installed with Go

Have you ever installed a package by using go install <some-package> and wondered how to uninstall it? Go is really great in that respect. Go packages are a single binary and they’re installed based on how your Go tooling is set up. Provided we have ...

Mar 15, 20252 min read

Uninstalling a package installed with Go

Open API (Part 3): Generating an OpenAPI spec file from code

Overview This is the 3rd article in a series of posts about working with Open API to create generated API clients and documentation websites. In the 1st post we went over what we can do with Open API spec files, e.g. generate API clients and documen...

Oct 14, 20247 min read

Open API (Part 3): Generating an OpenAPI spec file from code

Open API (Part 2): Handcrafted, bespoke, artisanal Open API specs: API contract-first

Overview This article is the 2nd in a series of blog posts that discuss using Open API to help with API documentation and API client code generation. In the previous article, we went over how we can generate documentation and API clients using existi...

Oct 7, 20246 min read

Open API (Part 2): Handcrafted, bespoke, artisanal Open API specs: API contract-first

Open API (Part 1): Generating API clients and documentation from an Open API spec

Overview This article starts a series of Open API-related blog posts. OpenAPI, previously known as Swagger (a name still in use today for many of its tools), is a suite of tools that generate documentation and networking clients for various programmi...

Sep 30, 20245 min read

Open API (Part 1): Generating API clients and documentation from an Open API spec

Android apps are reading your clipboard – here's how you can stop them

You've probably already seen the scary alert (that's possibly why you're here), but in case you haven't, it looks something like this: NewAppIJustDownloaded pasted from your clipboard Sometimes it h

Sep 20, 20249 min read

Android apps are reading your clipboard – here's how you can stop them

Tinacious Design Blog

47 posts

My experience with DocPad

After a bit of research, I opted to try Docpad, an open-source static site generator built using Node.js. This tool is a pretty good tool for developers, allowing you to author your content in Markdown format and generate static HTML files. I opted for a database-free installation, so all of my site's content can be checked into version control as text files that are later generated into HTML on the server. There are many plugins available to extend the basic functionality of a DocPad site, including front-end frameworks, and integration with the build tools you already love, like CSS preprocessing with Less, Sass, and Stylus, JavaScript preprocessing, and HTML templating engines. There are still a few quirks with it, and, from my experience, and that of others, performance during development can be slow or come to a halt (i.e. file watching and re-rendering)—and this problem grows as your site does—but it works for small, low-maintenance sites. I would not personally use it for enterprise or client sites—unless your client's site will be very small and they will be completely hands-off—but it's a great, open-source tool with a good amount of plugins available for commonly desired functionality and build tools. At the time of this article, DocPad is actively being maintained. I think DocPad is in its early stages and has a lot of potential to be a great tool for developer websites provided that the performance kinks get worked out.

Serving a DocPad website on Ubuntu

Ubuntu is my operating system of choice when it comes to serving a website. Digital Ocean is an affordable VPS platform with plans as low as $5 per month with 512 MB of RAM and 20 GB of storage on a solid-state drive. A LAMP stack would require the next plan up to run reliably but the $5 plan works great for a static site with minimal dynamic functionality. I wrote a tutorial for Digital Ocean that provides step-by-step instructions on deploying a DocPad website to Ubuntu. If you are interested in learning how to serve a DocPad website on an Ubuntu VPS, please see the tutorial article How to Deploy a DocPad Application on Ubuntu.

Command Palette

Comments

More from this blog

My experience with DocPad

Serving a DocPad website on Ubuntu