Quick start

JPROT turns a folder of Markdown files into a website with no build step. Node.js 18+ is the only requirement.

Prerequisites

Copynode --version   # v18 or newer

Install Node.js from https://nodejs.org if needed (use the LTS release).

1. Scaffold a site

Fastest path — scaffold and install dependencies in one step:

Copynpm create jprot@latest my-site
cd my-site
npm start

or scaffold into the current folder and let it install:

Copynpm create jprot@latest

@latest keeps you on the newest release. The flag --docs gives a documentation starter and --resume a CV-style site (default is a portfolio).

Alternative when JPROT is already installed or you prefer npx:

Copymkdir my-site
cd my-site
npx jprot init --portfolio

jprot init never overwrites existing files, so re-running it is safe — but it does not install dependencies for you (run npm install once if the jprot binary is not available).

2. Run the preview server

Copynpm start

(The scaffolded project includes a start script that runs the jprot command-line tool. If you only ran JPROT via npx without a global install, use npx jprot instead — same server.)

Open http://127.0.0.1:4114. If the port is busy, JPROT picks the next free port; start on a specific port with jprot 5000. Stop the server with Ctrl+C.

3. Add a page

Create content/hello.md:

Copy---
title: Hello
description: My very first JPROT page.
---

# Hello

This page is alive!

Open http://127.0.0.1:4114/hello. There is no build step — save the file and refresh. Every file in content/ becomes a page at its path:

File	URL
content/index.md	/
content/about.md	/about
content/blog/first-post.md	/blog/first-post

What's next

• Create your first site — project structure and workflow.
• Write content — Markdown, frontmatter, projects, shortcodes.
• Publish — export to GitHub Pages or any static host.