Command Line

To use LuaWebGen, navigate to your site's root folder and run this from the command line:

webgen command [options]

or, in the universal version:

lua path/to/webgen.lua command [options]

• Commands
• Build Options

---

Commands

build

webgen build [options]

Build the website. Also look at the available build options.

new page

webgen new page <pagePath>

Create a new page with some basic information. Example:

webgen new page "blog/first-post.md"

new site

webgen new site <folderName>

Initialize a folder to contain a new site. Example:

webgen new site "internet-dogs"
cd "internet-dogs"
webgen new page "blog/first-post.md"
webgen build

Build Options

--autobuild

--autobuild or -a

Auto-build website when changes are detected. This makes LuaWebGen run until you press Ctrl+C in the command prompt.

--drafts

--drafts or -d

Include page drafts when building.

--force

--force or -f

Force-update all. This makes LuaWebGen treat all previously outputted files as if they were modified. This has the same effect as deleting the output folder.

--verbose

--verbose or -v

Enable verbose printing to the console.