Skip to content

README.md

Latest commit

 

History

History
41 lines (26 loc) · 1.38 KB

README.md

File metadata and controls

41 lines (26 loc) · 1.38 KB

Poetry Website

Poetry

This is the source of the official Poetry website.

It's built using the static site generator Hugo and the Markdown docs from the Poetry repo.

Requirements

Local development

Note

The following commands require GNU Make 4.3 or newer (the Makefile uses grouped targets, introduced in 4.3). If you are on macOS, which may still ship an older version; install a newer version with brew install make and invoke it as gmake.

To work on this project locally, first fork and clone this repo. Then:

make site

or, to instead use docs from a local poetry repo:

make site POETRY_REPO=../path/to/local/poetry/repo

This will

  • Either fetch or symlink docs/*.md from the poetry repo into content/docs
  • Concurrently run rollup to compile assets and hugo to serve content

The website will now be accessible at http://localhost:1313 and reload on any changes.