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

Add a man page for markdown2tex #547

Closed
2 tasks done
Witiko opened this issue Jan 29, 2025 · 1 comment · Fixed by #554
Closed
2 tasks done

Add a man page for markdown2tex #547

Witiko opened this issue Jan 29, 2025 · 1 comment · Fixed by #554
Labels
distribution Related to the distribution of the Markdown package for TeX documentation Related the technical documentation, the user manual, and the README files
Milestone

Comments

@Witiko
Copy link
Owner

Witiko commented Jan 29, 2025

In version 3.10.0, we aliased markdown-cli.lua as markdown2tex.lua, which has been made available as the executable markdown2tex in TeX Live 2024, as discussed on [email protected]. Following this exchange, @kberry requested that a man page be added for the script:

Imported the new version and did that for tonight's TL update.

No problem there, but can you also please write or generate a man page for the next release? The distros will appreciate it. afm2tfm.1 is a simple handwritten man page that can serve as a template if needed.

Tasks

  • Generate a man page markdown2tex.1 from markdown.dtx and markdown.ins.
  • Install the man page in Makefile.
@Witiko Witiko added distribution Related to the distribution of the Markdown package for TeX documentation Related the technical documentation, the user manual, and the README files labels Jan 29, 2025
@Witiko Witiko added this to the 3.11.0 milestone Jan 29, 2025
@Witiko
Copy link
Owner Author

Witiko commented Feb 3, 2025

We should also use this opportunity to flatten the output of markdown2tex for greater ease of use. Specifically, unless the option finalizeCache has been enabled, markdown2tex should produce the top-level TeX output directly, not \input CACHE_FILENAME. Now, if eagerCache has been enabled, the file CACHE_FILENAME may still be produced to speed up future conversions of the same document. However, the file should still be inlined in the output of the command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
distribution Related to the distribution of the Markdown package for TeX documentation Related the technical documentation, the user manual, and the README files
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant