Getting Started
Install Blog-Doc, start the server, and build your first static site.
Blog-Doc runs locally on your machine. There is no cloud, no database, no authentication. You write content in Markdown, manage it through the admin GUI, then build a complete folder of static HTML files ready to deploy anywhere.
This section walks you through installation, the project layout, and the moment you first see your site running.
Prerequisites
- Node.js 18 or later — check with
node --version - npm — bundled with Node.js
- A terminal and a modern browser
Install
You can use npx
npx create-blog-doc my-blog
Replace my-blog with whatever you want your project folder to be named.
Or use npm init
npm init blog-doc my-blog
Replace my-blog with whatever you want your project folder to be named.
Or clone the repository and install dependencies:
git clone https://github.com/lebcit/blog-doc.git
cd blog-doc
npm install
Start the server
npm start
For development with auto-restart on file changes:
npm run dev
The server defaults to port 3000. Override it with a .env file:
PORT=8080
Open your browser
| URL | What you'll find |
|---|---|
http://localhost:3000/admin |
Admin interface |
http://localhost:3000 |
Live site preview |
The live site shows whatever your active theme renders. On a fresh install, the default theme is active.
Build and deploy
When you're ready to publish, click Build Site on the Dashboard. Blog-Doc generates a _site/ directory containing clean HTML, your theme assets, and everything else needed for a fully static site.
Download the _site/ ZIP from the Dashboard and drop it on any static host or a plain VPS. No server-side code required.