This release is a pre-release and may not be stable for production use.
The Python module multimd
I beg your pardon for my english...
English is not my native language, so be nice if you notice misunderstandings, misspellings, or grammatical errors in my documents and codes.
This document is a short tutorial showing the most useful features without being exhaustive.
About multimd
Working with moderate sized MD documents in a single file can quickly become tedious. This project allows you to go through separate small MD files to be merged into a final single MD file.
At the moment, resources, such as images, are not managed.
README.md part by part
With multimd, you can write a MD document by typing small section-like parts which are easy to maintain. Consider the README.md file from the src2prod project which was written using the following tree on 6 May 2023.
+ src2prod
* README.md
+ readme
* about.yaml
* about.md
* build.md
* cli.md
* example-used.md
* only-files.md
* prologue.md
* readme-splitted.md
+ ...
The special about.yaml file is used to specify a specific order in which the different MD files are put together (without this file, a "natural" order is used). Its content is as follows: we give the list of the files without their extension.
toc:
- prologue
- about
- example-used
- build
- only-files
- readme-splitted
- cli
WARNING! You can use relative paths but you must use the Unix path separator
/.
Building the final README.md file is done quickly on the command line using multimd after using the cd command to go into the src2prod folder. We use the option -e to allow to erase an existing README.md file.
> multimd -e readme README.md
Successfully built file.
+ Path given:
README.md
+ Full path used:
/full/path/to/README.md
There is also an easy-to-use Python API.
from multimd import Builder, Path
mybuilder = Builder(
src = Path("/full/path/to/readme"),
dest = Path("/full/path/to/README.md"),
erase = True
)
mybuilder.build()
NOTE. It is possible to work with subfolders containing
MDfiles. In this case,multimdwill work recursively. In theabout.yamlfile, the path to a subfolder simply ends with the Unix path separator/like inone/sub/folder/.
Without the special about.yaml file
Without an about.yaml file, all the MD files will be merged into one after sorting them in a "natural" order.
WARNING! Without an
about.yamlfile, it is impossible to work with subfolders containingMDfiles.
Metadata
Release files for multimd 0.3.2b0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| multimd-0.3.2b0.tar.gz | 18.4 kB | Without provenance | Details for multimd-0.3.2b0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| multimd-0.3.2b0-py3-none-any.whl | Python 3 | none | any | Details for multimd-0.3.2b0-py3-none-any.whl |
Total release size: 38.6 kB
Release files / multimd-0.3.2b0.tar.gz
| Download URL | multimd-0.3.2b0.tar.gz |
|---|---|
| Size | 18.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dce5995ae290c5784f0cc50370f5f98873ee89649b2fc0efb7d65565238f0f8a
|
|
BLAKE2b-256 checksum How to use checksums |
cf6bb797427f570e930625945c23aff821f4f5446ae7916c8abf4ab545b1012f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.9.16 Darwin/20.6.0
|
Release files / multimd-0.3.2b0-py3-none-any.whl
| Download URL | multimd-0.3.2b0-py3-none-any.whl |
|---|---|
| Size | 20.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2ed4b94c8e1acea7749edfcb23ddd2b532ee8c02209704e4eba837d06de732cf
|
|
BLAKE2b-256 checksum How to use checksums |
b2cdcf346893fe0d02bb2e6ae90270294552fd5fb5568e32f3e1df47cac6b6d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.9.16 Darwin/20.6.0
|
Security for multimd 0.3.2b0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.