https://github.com/dbohdan/gmi2md
Convert gemtext to Markdown (CLI + PHP)
https://github.com/dbohdan/gmi2md
converter gemini-protocol gemtext markdown php
Last synced: about 1 month ago
JSON representation
Convert gemtext to Markdown (CLI + PHP)
- Host: GitHub
- URL: https://github.com/dbohdan/gmi2md
- Owner: dbohdan
- License: mit
- Created: 2024-08-11T11:51:58.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T18:54:35.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T12:17:22.086Z (over 1 year ago)
- Topics: converter, gemini-protocol, gemtext, markdown, php
- Language: PHP
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gmi2md
**gmi2md** is a command-line utility and PHP library
for converting [gemtext](https://geminiprotocol.net/docs/gemtext.gmi) to Markdown.
## Requirements
- PHP 8.0 or later to run gmi2md
- diff(1) and [just](https://github.com/casey/just) to test it
- [pretty-php](https://github.com/lkrms/pretty-php) and just to format the code
## Usage
### CLI
```shell
./gmi2md.php < tests/input.gmi
```
### PHP
The following code is also in [`example.php`](example.php).
```php
convert(file_get_contents('tests/input.gmi'));
```
## Design
gmi2md translates gemtext to a subset of Markdown that is compatible with major Markdown variants: CommonMark, GFM, Pandoc, and John Gruber's original Markdown.
It preserves vertical whitespace.
In gemtext, if one line follows another, the lines are separate paragraphs;
in Markdown, the lines are merged into a single paragraph.
gmi2md separates gemtext paragraphs with a blank line to make them paragraphs in Markdown.
I have made a stylistic decision to merge links into one Markdown paragraph in the output when they directly follow each other in the gemtext input.
What this mean is that we do not insert blank lines between links to make them different paragraphs.
Rather, each line with a link after a paragraph or after the first link of the group when there is no preceding paragraph is prefixed with `
` in the Markdown output.
The gemtext in the first of the following code blocks is translated to the Markdown in the second:
```gemtext
Lorem ipsum.
=> https://example.com/1
=> gemini://example.com/2
```
```markdown
Lorem ipsum.
[gemini://example.com/2](gemini://example.com/2)
```
Gemtext where the links are separated with newlines is translated differently:
```gemtext
Lorem ipsum.
=> https://example.com/1
=> gemini://example.com/2
```
```markdown
Lorem ipsum.
[gemini://example.com/2](gemini://example.com/2)
```
To change this behavior, instantiate the converter with a separator prefix other than the default `
`.
For example:
```php
// No link grouping. Insert blank lines.
$converter = new GemtextToMarkdownConverter("\n");
```
## Development
gmi2md was written by Claude 3.5 Sonnet for the initial commit, fixed and improved in various ways by a human, and refactored by Claude.
It was a first for me.
I have [written about its development](https://dbohdan.com/gmi2md).
## License
Copyright law is not yet clear about generated code.
This code is a combination of machine and human contributions.
One may expect that the code will be considered an original and copyrightable work.
I am therefore releasing it under the MIT License.
See [`LICENSE`](LICENSE).
I am not a lawyer.
Use code that is partially generated by AI at your own risk.