uEdition 2.0.1

No project description provided

μEdition

The μEdition is a micro framwork for quickly building Editions.

---

Table of Contents

• Quickstart
• Documentation
• License

Quickstart

To quickly get started with the μEdition follow these steps:

1. Install Hatch for your operating system.

2. Create a new folder for your μEdition.

3. Download the default {download}https://uedition.readthedocs.io/latest/en_static/pyproject.toml and move that into your new folder.

4. Open a new terminal, change into your new folder and run the following command:

   :::{code-block} console hatch run init :::

   This creates the configuration file ({file}uEdition.yml) and table of contents ({file}toc.yml).

5. Then run the following command to add content in a new language:

   :::{code-block} console hatch run language add :::

   This will ask you a few questions about the new language and then create the required files.

6. Then run the following command to start the writing server:

   :::{code-block} console hatch run serve :::

Documentation

Full documentation is available at https://uedition.readthedocs.io.

License

The μEdition is distributed under the terms of the MIT license.