Migrate from README.md to README.org #739
Merged
Conversation
This file contains 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
kristijanhusak
requested changes
May 30, 2024
SlayerOfTheBad
pushed a commit
to SlayerOfTheBad/orgmode
that referenced
this pull request
Aug 16, 2024
* Migrate headings and code blocks * Migrate inline code to ~code~ notation * Migrate most links and images * Fix title * cope with Github's broken headline hierarchy * Migrate embedded html * Migrate Headline logo and goodies/buttons * Safer option for main logo * Second attempt at logo+goodie formatting * Title under logo * Kofi Chat and other logos * Replace <kbd> tags with =key= notation * Capitalize BEGIN_SRC & END_SRC for consistency * Fix html linebreak * Fix mismatched code block * no need to escape < > for vim keys (i.e. <leader>) * Attempt to fix kofi icon * One more time * Multiple formating fixes * More minor changes * Add alt-text to top buttons * Fix small formatting issues (almost complete) * attempt to use native org checkboxes * "Fix" checkboxes with emojis * More emoji fixes * Small inline code fix * Fix small typo --------- Co-authored-by: Kristijan Husak <husakkristijan@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 entire plugin is about orgmode. I recently noticed that github supports formatting README files with
.orgnotation.I let myself be inspired by this beautiful repo and decided I'd try my hand at migrating this repos' README as it only felt fitting.
I had to make two concessions to read feature parity with your readme:
<kbd>tags and inline code look the same=key=notation and inline code with~code~notation to make it easier to refactor if a better solution is found- [ ]and- [x]) were not getting formatted properly:white_check_mark:and:white_square_button:to obtain a similar effectFeel free to look at the result on my fork of the repo