edition 1.0.0a2

Lightweight documentation generator

📰 Edition

WARNING: This is a pre-release project.

Edition is a command-line application for creating beautiful HTML and Markdown editions of your projects' documentation.

In fact, the document you're reading right now was pressed by Edition.

✨ Highlights

• Write your documentation once.
  Edition will give you an README.md to upload to your project, PyPI and all the rest, and a beautiful HTML page ready to upload directly to GitHub or GitLab Pages.
• Works out of the box.
  With one command, your existing README.md can be converted to beautiful HTML.
• Embed your code samples.
  Edition will execute your code and embed the results.

✋ Example

Create this Markdown document named example-source.md:

# Edition example

Save this file to your local machine as `example-source.md`
then run:

```bash
edition example-source.md example.html --press html
```

Now open `example.html` in a web browser. The code example
below will be complete.

```bash
python --version
```

<!--edition-exec-->

Run:

python -m edition docs/example-source.md docs/example.html --press html

warn: no value for author
warn: no value for favicon-emoji

This will generate example.html. Open that file in a web browser.

🤔 Is Edition right for you?

Edition could be great for you if:

• You've tried other documentation tools and they were more complex or time-consuming than you care for
• Your documentation fits on a single page

Edition is not a feature-matching substitute for Sphinx, mkdocs, pdoc or the like, nor is Edition aiming to be.

If you need multi-page documentation, docstring parsing or fine configuration then Edition is not right for you.

⚙️ Getting Started

Edition requires Python 3.8 or later.

Install Edition via pip:

pip install edition

📄 Creating your source document

Your source document is the Markdown document from which all your editions will be pressed.

Any Markdown document you already have -- like your project's README.md -- is already a valid source document, but we can add some front matter and additional markup to help guide the presses.

Front matter

The following front matter properties come into play only when pressing HTML.

Property	Description	Default
author	Author name	No author
favicon-emoji	Emoji to use as favicon	No favicon
title	Page title	Top-level heading

For example:

---
author: Cariad Eccleston
favicon-emoji: 🍕
# If "title" was omitted then the top-level "Example"
# heading would be used instead:
title: Embedded Example

---
# Example

Markup

Code execution

To have Edition execute your code then embed the result:

1. Create a regular Markdown code block
2. Add <!--edition-exec--> after the block

For example:

```python
print("Hello, world!")
```

<!--edition-exec-->

Currently only bash and python code blocks are supported. More languages can be added if they are requested.

Table of Contents

<edition value="toc" />

🍰 Contributing

Thank you for considering contribution!

To contribute a bug report, enhancement or feature request, please raise an issue at github.com/cariad/edition/issues.

If you want to contribute a code change, please raise an issue first so we can chat about the direction you want to take.

👮‍♀️ Licence

Edition is released at github.com/cariad/edition under the MIT Licence.

See LICENSE for more information.

👩‍💻 The Author

Hello! 👋 I'm Cariad Eccleston and I'm a freelance DevOps and backend engineer. My contact details are available on my personal wiki at cariad.earth.

Please consider supporting my open source projects by sponsoring me on GitHub.

🔗 Related Projects

• Epic thanks to John Gruber for releasing the Markdown specification.