Docpress: a documentation site generator that starts from your README

The input is the README, not a template

What Docpress generates is a website from the documentation a project already has. The description says it generates websites from your project's basic documentation, that is at the very least a README.md file, and it also supports multiple Markdown pages placed in a docs folder. That is the whole contract, and it is narrower than a static site generator in the usual sense. There is no theme marketplace, no content pipeline and no front matter convention to learn, because the entry point is the file every repository already has. The repository layout reflects the same shape, with a lib directory for the implementation, a bin directory holding the command, a docs directory for the documentation of the project itself, a fixture directory used by the tests, and a test directory. The command is published on npm as docpress, with the bin field pointing at the script in the bin directory, and the package main entry is an index.js at the root.

Install it globally, write a README, and serve

The quickstart in the readme is short and shows the whole workflow, including what the development server prints:

$ npm install -g docpress
$ echo "# My project" > README.md
$ echo "Documented by Markdown files." >> README.md
$ docpress serve

The install is a global npm install, which is a decision that dates the project and is worth noting before you reach for it, since a global install means the tool is shared across everything on the machine. The last two lines create a README with a heading and a line of text, which is enough to make the generator produce something, and the serve command then starts the development server. The output the readme shows is the detail that matters for the experience, since it reports a first build in a few hundred milliseconds and then says it is watching changes, that it is running livereload and that it is serving on the local port 3000. Watching changes and live reload together is what makes it a documentation authoring loop rather than a build-and-refresh step, and the port is fixed at 3000 in the example.

The architecture is Metalsmith, and the pieces are split across packages

The dependency list shows how the generator is put together. There is a base package and a core package, both versioned with a tilde, and both from the same project, and they are where the actual generation logic lives. On top of them sits a start plugin for Metalsmith, pinned to a specific commit on GitHub rather than a version, which tells you the build tool underneath is Metalsmith and that the project depends on a particular fix or feature in it. The command line arguments are handled by yargs. The split into a base and a core package is a common pattern for a project that wants to reuse its rendering logic in other contexts, and the fact that the start plugin comes from a fork pinned by commit hash rather than from the registry is a warning sign about the maintenance state of the dependency chain. The development dependencies tell the rest of the story, with browserify for bundling the browser assets, uglifyify for minification, mocha with nyc for the test and coverage run, expect for assertions, standard for linting, standard-version for the release process and a git-update-ghpages package for publishing the built site to a GitHub Pages branch.

The deploy path, and how the site is published

The publish mechanism is visible in the package scripts, and it is the part of the project that has aged most. The deploy script runs the build command in the bin directory and then invokes the GitHub Pages update tool, passing a branch of master, the target repository and the output directory. The pattern is the conventional one for a documentation site of that era, where the built output lives in a separate repository and a push to a branch triggers GitHub Pages to serve it. The release script uses standard-version, which derives the version from the commit history and generates the changelog, and the test script runs the coverage tool over mocha with the lint step running first as a pretest hook. The project also carries a dependency status badge for both the runtime and the development dependencies, which is a quiet admission that the dependency tree is large relative to what the tool does, and a coverage badge pointing at coveralls for the master branch. The release history shows a single tagged release, 0.7.1 from 2016-11-01 described as a Disqus docs and base bump, while the package version in the repository has moved on to 0.8.2.

A preview, and what the documentation does not yet say

The readme is candid that the project is a preview. The usage section says it is still under heavy development and to consider it a preview, with a node v8 or newer requirement, and the what-is-it section repeats that it is under heavy development with guides and instructions to appear when the project is stable. The tone is worth quoting in spirit, because it tells you the state of the thing: the quickstart guide is the real documentation and the readme is a signpost. There is an examples page in the docs directory that shows how developers used the tool to build documentation sites, and a getting started guide in a subdirectory of the docs that the readme points to. The support section gives the documentation site and a Gitter chat. The credits name the author and maintainer, Rico Sta. Cruz, with a list of contributors, and the licence is stated in the readme itself as MIT, with the package metadata agreeing, while the licence field recorded for the repository is not identified. The last push was on 2026-06-10.

Editorial conclusion

Docpress is a good fit for a small project that already writes its documentation in Markdown and wants a hosted documentation site with navigation, without adopting a full static site framework and a theme on top of it. It is the wrong choice if you need a maintained toolchain, because the project has been quiet for a long time, with the only tagged release being 0.7.1 from 2016 while the package version in the repository is 0.8.2 and the last push was on 2026-06-10. It is also the wrong choice if you need a feature rich static site generator with themes and plugins, since the design goal here is explicitly painless rather than extensible. Before adopting it, read the getting started guide rather than the readme, and check the node version you have, since the documented requirement is Node v8 or newer and the project depends on a pinned commit of a build tool. The project is MIT licensed, authored and maintained by Rico Sta. Cruz with contributors.

Frequently asked questions

Official sources

1. docpress/docpress on GitHub
2. Issues
3. Project website
4. README
5. Releases