Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

suggestion for another flavor #5

Open
bentxt opened this issue Jan 30, 2023 · 4 comments
Open

suggestion for another flavor #5

bentxt opened this issue Jan 30, 2023 · 4 comments

Comments

@bentxt
Copy link

bentxt commented Jan 30, 2023

I would like to suggest another more Markdown based flavor when it comes to formatting code blocks und inclusion directives.

Rationale: While everyday coding in the Literate Programming style can be a bit cumbersone, I really like the technique for creating smaller bits of "executable" documentation for the web like blog posts. In this scenario my prefered format is Markdown and the first and formost concern is to publish an article and not to develop software.

Suggestion Code Blocks

Article text

``` { #hellocode .ocaml }
let _ = print_endline "Hello"
```

``` { #hello.ml .ocaml }
<<hellocode>>
```

Hand this is how the html is generated, including nice syntax highlightning

pandoc -s --from=markdown+fenced_code_attributes hello.ml.md > hello.html

I already have changed the regex in lang/web.ml, so I already have a working version.

What do you think of all this?

@bentxt
Copy link
Author

bentxt commented Jan 30, 2023

Some additional references:

@aryx
Copy link
Owner

aryx commented Jan 30, 2023

sounds good to me!

@aryx
Copy link
Owner

aryx commented Jan 30, 2023

If you have a PR I'll be happy to review it and merge it

@bentxt
Copy link
Author

bentxt commented Jan 30, 2023

If you have a PR I'll be happy to review it and merge it

sorry for going of topic, do you by any chance have some experience with this? What would be the workflow/steps you'd suggest here? I avoid version control and especially git like the plague, but I think I'm ready to make another effort.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants