org-view-mode VS dired-auto-readme

See if org-view-mode has something you can (re)use. It is not so much about styling aside from some quotes, and centered headlines, but more about removing unnecessary noise. See if it inspires or helps, it is relatively small and hopefully simple code.

For the clutter, you can try hiding src blocks or if you prefer hide all markup.

I wrote a little addon to dired to automatically display readme files in directories if there is one. I use it all the time, autoloads with my dired. I also wrote an init file generator and manager that I use every day, as long as some small packages to cleanup org mode noise, summarized in org-view-mode. Generally I use elisp instead of bash to cleanup directories, batch rename files in some special folders according to some specific naming rules etc. I also wrote an elisp script to re-build emacs, lots of other small stuff I haven't published on my github. You can check here some small extras I wrote or adapted from others for my personal use.

If you need some example of using text properties, here is some of my code, not sure if it is very good example, but it is very short and hopefully easy to understand. Here is a bit more elaborated one, and here is a bit of unorthodox usage of Emacs, also using text properties to achieve the effect. I don't recommend anything for "stable" system, beside org-view-mode, rest are just experiments and idea tests.

For the usage info, check the README file in the Github repository.

I have just reworked dired-auto-readme, fixed some bugs and made it aware of org-view-mode, so now it is possible to see readme files written in org mode without markup in Dired buffers. For example, here is a screenshot of org-tree-slide package by T. Ishikawa, cloned from his GitHub repo.

My attempt at pretty rendering paragraphs in org-mode: aligned vertically to left, right, middle and displayed with custom fonts.

I have been hacking last weekend on my org-view mode. It can now prettify quotes, verses and centered paragraphs by applying alignment and custom faces. It should now also work in older versions than the current master :).

You can write your own minor mode, or just simply iterate through all headings with a given tag, and fold it in with-eval-after-load. You can check this code and see if it gives you an idea how to do it. Check part for tags; instead of setting invisible property for tag, you can fold your heading. Also match tags with specific keywords in them, not all tags as I do in regex.

Simplest and narutal is to display three different windows; hide scrollbars and you will be left with very thin line (1 pixel wide) between windows. Alternatively you can do some tricks to work around the issue similar as to what org-mode does, or something similar as to what I do in dired-auto-readme. I don't suggest since you will be fighting Emacs, and there are many issues and problems with what org or my package do. There is a reason why org uses src_blocks, and while org is great and do awesome job at what it does, there are still issues that are not easily overcome when you scratch under the surface (for example font-lock is in certain cases spooking, you don't have major/minor mode maps in src blocks, eldoc is not working properly etc.

I have used Clemeras dired-git-info for a while, but it does not work well with my dired-auto-readme and dired-subtree from dired-hacks due to use of overlays.

I wrote a little addon to dired to automatically display readme files in directories if there is one. I use it all the time, autoloads with my dired. I also wrote an init file generator and manager that I use every day, as long as some small packages to cleanup org mode noise, summarized in org-view-mode. Generally I use elisp instead of bash to cleanup directories, batch rename files in some special folders according to some specific naming rules etc. I also wrote an elisp script to re-build emacs, lots of other small stuff I haven't published on my github. You can check here some small extras I wrote or adapted from others for my personal use.

If you need some example of using text properties, here is some of my code, not sure if it is very good example, but it is very short and hopefully easy to understand. Here is a bit more elaborated one, and here is a bit of unorthodox usage of Emacs, also using text properties to achieve the effect. I don't recommend anything for "stable" system, beside org-view-mode, rest are just experiments and idea tests.

I have just reworked dired-auto-readme, fixed some bugs and made it aware of org-view-mode, so now it is possible to see readme files written in org mode without markup in Dired buffers. For example, here is a screenshot of org-tree-slide package by T. Ishikawa, cloned from his GitHub repo.

My goal is to create a clean and minimal viewer, org-view-mode, which will generally hide everything but text and put org file in read only mode. I need it for my dired-auto-readme. In general, when I read other people's stuff, I don't care about their markup, I am just interested about the content. I don't understand why is there no such mode from the beginning.