Skip to content

site-guide

Getting started

To get started with Poetry, clone or fork the repository and install the required dependencies. Development should be done on the master branch; the pages branch contains the build.

  1. Clone or fork the repository:
git clone https://codeberg.org/impalcature/poetry.git
  1. Enter the project directory:
cd poetry
git switch master
  1. Install the dependencies:
npm install

Running the development server

To start the development server:

npm run start

The site will be available at http://localhost:8080.

Building for production

To generate the production build:

npm run build

The generated files are placed in the dist folder, ready to be deployed to the hosting service.

Deploying to a subfolder

If the site is deployed in a subfolder, such as /poetry/ on Codeberg Pages, run:

SUBFOLDER=true npm run build

In eleventy.config.js replace /poetry with the subfolder path required by your hosting service:

if (process.env.SUBFOLDER === "true") {
    addPathPrefix(eleventyConfig, "/poetry");
}

The SUBFOLDER option only changes the URLs generated in the HTML files; the resulting dist folder is otherwise unchanged and ready to be deployed.