Skip to content

Commit cbaffc6

Browse files
committed
wip readme
1 parent a3d7ac4 commit cbaffc6

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,29 @@
22

33
<p align="center">
44

5-
[![Crates.io](https://img.shields.io/crates/v/markdown2pdf)](https://crates.io/crates/markdown2pdf)
6-
[![Documentation](https://img.shields.io/docsrs/markdown2pdf)](https://docs.rs/markdown2pdf)
7-
[![License](https://img.shields.io/crates/l/markdown2pdf)](LICENSE)
8-
[![Downloads](https://img.shields.io/crates/d/markdown2pdf)](https://crates.io/crates/markdown2pdf)
9-
[![GitHub Stars](https://img.shields.io/github/stars/theiskaa/markdown2pdf)](https://github.com/theiskaa/markdown2pdf/stargazers)
5+
[![Forked From](https://img.shields.io/badge/forked--from-theiskaa%2Fmarkdown2pdf-blue)](https://github.com/theiskaa/markdown2pdf)
6+
[![Repository](https://img.shields.io/badge/repo-sctg--development%2Fmarkdown2pdf-green)](https://github.com/sctg-development/markdown2pdf)
7+
[![Crates.io](https://img.shields.io/badge/crates.io-unpublished-lightgrey)](https://github.com/sctg-development/markdown2pdf)
8+
[![Documentation](https://img.shields.io/badge/docsrs-unavailable-lightgrey)](https://github.com/sctg-development/markdown2pdf)
9+
[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
10+
[![GitHub Stars](https://img.shields.io/github/stars/sctg-development/markdown2pdf)](https://github.com/sctg-development/markdown2pdf/stargazers)
1011

1112
</p>
1213

14+
> **Fork notice:** This repository is a fork maintained at `https://github.com/sctg-development/markdown2pdf`.
15+
>
16+
> **Important:** The fork is **not published on crates.io**. To install this fork use:
17+
>
18+
> ```bash
19+
> cargo install --git https://github.com/sctg-development/markdown2pdf
20+
> ```
21+
>
22+
> Or build from source with:
23+
>
24+
> ```bash
25+
> cargo build --release
26+
> ```
27+
>
1328
markdown2pdf converts Markdown to PDF using a lexical analyzer and PDF rendering engine. The library tokenizes Markdown into semantic elements, applies styling rules from TOML configuration, and generates styled PDF output.
1429
1530
Both binary and library are provided. The binary offers CLI conversion from files, URLs, or strings. The library enables programmatic PDF generation with full control over styling and fonts. Configuration can be loaded at runtime or embedded at compile time for containerized deployments.
@@ -35,12 +50,12 @@ cargo install markdown2pdf
3550
For the latest git version:
3651

3752
```bash
38-
cargo install --git https://github.com/theiskaa/markdown2pdf
53+
cargo install --git https://github.com/sctg-development/markdown2pdf
3954
```
4055

4156
### Prebuilt binaries
4257

43-
Prebuilt versions are available in our [GitHub releases](https://github.com/theiskaa/markdown2pdf/releases/latest):
58+
Prebuilt versions are available in our [GitHub releases](https://github.com/sctg-development/markdown2pdf/releases/latest):
4459

4560
| File | Platform | Checksum |
4661
|--------|----------|----------|

0 commit comments

Comments
 (0)