μEdition#

The process of creating and making available a (critical) digital edition often presents projects with a range of significant hurdles, particularly around technical knowledge and hosting costs. The μEdition is a framwork that lowers these barriers by providing a simple tool that supports users in easily building (multi-lingual) digital editions that can then easily be made available online using free or low-cost hosting solutions.

Getting Help

The μEdition is still a young project and relies on your feedback to further lower the barriers to its use. Whether this is adding documentation on how to do things, fixing broken things, or adding extra features, please let us know what is needed and then we can make it better.

If you have any questions about anything related to the μEdition, please use our GitHub Discussions forum to ask: uEdition/uEdition#discussions.

If you run into any bugs, then please report these via the GitHub Issues and we can get them fixed: uEdition/uEdition#issues.

Contents#

Quickstart#

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

Install Python for your operating system, if it is not yet installed. The μEdition supports all Python versions that are currently supported.
Install Hatch for your operating system.
Create a new folder for your μEdition.
Download the default _static/pyproject.toml and move that into your new folder.
Open a new terminal, change into your new folder and run the following command:
```
hatch run init
```
This creates the configuration file (uEdition.yml) and table of contents (toc.yml).
Then run the following command to add content in a new language:
```
hatch run language add
```
This will ask you a few questions about the new language and then create the required files.
Then run the following command to start the writing server:
```
hatch run serve
```
Your new μEdition will be available at http://localhost:8000.
To use the μEditor for editing the μEdition, run the following command in a separate terminal:
```
hatch run edit
```
Your μEditor will be available at http://localhost:8080.