Generate README.md from sudo-edit.el using make-readme-markdown #26
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds support for generating our README.md from sudo-edit.el source itself using make-readme-markdown [1]. This is nice because, as per the MRM docs [1], "when you're writing an elisp module, the module itself should be the canonical source of documentation. But it's not very user-friendly or good marketing for your project to have an empty README.md that refers people to your source code, and it's even worse if you have to maintain two separate files that say the same thing." [1] https://github.com/mgalgs/make-readme-markdown
Hard to tell if that's a shell command or what. Prefix with M-x to make it clear that it's an interactive Emacs command.
Author
|
See my fork for a preview of the rendered markdown looks: https://github.com/mgalgs/sudo-edit |
nflath
approved these changes
Nov 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds support for generating our README.md from the sudo-edit.el source
itself using make-readme-markdown [1].
This is nice because, as per the MRM docs [1], "when you're writing an
elisp module, the module itself should be the canonical source of
documentation. But it's not very user-friendly or good marketing for your
project to have an empty README.md that refers people to your source code,
and it's even worse if you have to maintain two separate files that say the
same thing."
[1] https://github.com/mgalgs/make-readme-markdown