An open API service indexing awesome lists of open source software.

https://github.com/python-poetry/website

Source for the official Poetry website
https://github.com/python-poetry/website

hugo poetry python

Last synced: about 13 hours ago
JSON representation

Source for the official Poetry website

Awesome Lists containing this project

README

          

# Poetry Website

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][official website]

This is the source of the official [Poetry website][official website].

It's built using the static site generator [Hugo](https://gohugo.io) and the Markdown docs from the [Poetry repo](https://github.com/python-poetry/poetry/tree/main/docs).

[official website]: https://python-poetry.org

## Requirements

- [Poetry](https://python-poetry.org/docs/main/#installing-with-the-official-installer)
- [Node.js 18](https://nodejs.org/en/download/) (and `npm`)

## Local development

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

```sh
make site
```

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

```sh
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 and reload on any changes.