Skip to content

Commit

Permalink
README source link; note on GitHubPreview missing styles
Browse files Browse the repository at this point in the history
  • Loading branch information
lukstafi committed Jan 26, 2024
1 parent 9f3380b commit 249de66
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
6 changes: 4 additions & 2 deletions src/printbox-md/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# PrintBox-md: a Markdown backend for PrintBox

[This file was generated by the readme executable.](readme.ml)

## Coverage of Markdown and `PrintBox` constructions

### Single-line and multiline text
Expand Down Expand Up @@ -106,8 +108,8 @@ to separate the entries (here with style \`Line_break).
- <div><div style="border:thin solid"><div class="">to fallback on</div></div></div>


- HTML.
- Although it probably won't be perfect.
- HTML -- but it doesn't work on GitHub Preview.
- (GitHub ignores styles on \<div\> and \<span\> tags.)

### Trees

Expand Down
11 changes: 8 additions & 3 deletions src/printbox-md/readme.ml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ module B = PrintBox
module MD = PrintBox_md

let () = print_endline {|# PrintBox-md: a Markdown backend for PrintBox
|}

let () = print_endline MD.(to_string Config.default
@@ B.link ~uri:"readme.ml"
@@ B.line "This file was generated by the readme executable.")

## Coverage of Markdown and `PrintBox` constructions
let () = print_endline {|## Coverage of Markdown and `PrintBox` constructions

### Single-line and multiline text
|}
Expand Down Expand Up @@ -124,8 +129,8 @@ let () =
vlist ~bars:false [
line "when tables are configured";
frame @@ line "to fallback on";
line "HTML."];
line "Although it probably won't be perfect."
line "HTML -- but it doesn't work on GitHub Preview."];
line "(GitHub ignores styles on <div> and <span> tags.)"
]))

let () = print_endline {|### Trees
Expand Down

0 comments on commit 249de66

Please sign in to comment.