Command Line

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

lua "path/to/LuaWebGen/main.lua" some_command [options]

In Windows you can optionally add the bin folder to your PATH and take advantage of webgen.exe:

webgen some_command [options]

Much nicer! The rest of the documentation will use this format.

• Commands
• Build Options

---

Commands

build

webgen build [options]

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

new page

webgen new page "page_path"

Create a new page with some basic information. Example:

webgen new page blog/first-post.md

new site

webgen new site "folder_name"

Initialize a folder to contain a new site. Example:

webgen new site internetdogs
cd internetdogs
webgen new page blog/first-post.md
webgen build

Build Options

--autobuild, -a

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

--drafts, -d

Include page drafts when building.

--force, -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, -v

Enable verbose printing in the console.