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

Output markdown instead of HTML #50

Open
bas080 opened this issue Mar 12, 2021 · 2 comments
Open

Output markdown instead of HTML #50

bas080 opened this issue Mar 12, 2021 · 2 comments

Comments

@bas080
Copy link

bas080 commented Mar 12, 2021

Most opensource projects nowadays have a README in markdown format. It would be great to be able to have Literate generate this README for me.

To achieve this I need Literate to output markdown.

Although I agree that a README should not contain all source code, it would be nice to be able to reference certain code blocks in the README. Usage examples and performing project related tasks.

Also, if Literate outputs markdown, it would play nicer with other tools like pandoc and many other tools that allow markdown as input.

Maybe it's already possible to do this but I haven't been able to get it to work.

@brikis98
Copy link

+1

@bas080
Copy link
Author

bas080 commented Oct 7, 2021

I've experimented with the literate programming idea for a while now. I have added a concept of evaluating markdown code-blocks. With that feature I am able to also enable code weaving.

See:
https://github.com/bas080/markatzea - allows evaluating markdown code-blocks
https://github.com/bas080/memplate - a template language for working with code

Both tools are written in Perl.

I have used markatzea in many of my projects. One feature I like is that I'm able to evaluate my usage examples and test if they are still valid and working, while at the same time rendering the output of those processes.

Not trying to steal Literate's thunder here. Just trying to explore the world of literate programming and share my findings.

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