Quick Start

Quick Start Guide

Welcome to PageCraft! Follow this guide to get up and running quickly.

Installation

macOS

  1. Install Markdown:
    pip3 install markdown
  2. Clone the repository:
    git clone https://github.com/eli32-vlc/pagecraft.git
  3. Navigate to the project directory:
    cd pagecraft

Windows

  1. Download the precompiled binary from the GitHub Releases page (opens in a new tab).

Linux

  1. Follow the macOS installation steps.

Usage

Generate your content using the following commands:

macOS/Linux

python3 main.py input.md [optional custom copyright name]

Example:

python3 main.py index.md "Eason Li"

Windows

main.exe input.md [optional custom copyright name]

Example:

main.exe index.md "Eason Li"