On Fri, Oct 6, 2017 at 6:49 PM, R0b0t1 <r03...@gmail.com> wrote: > On Fri, Oct 6, 2017 at 5:41 PM, <tu...@posteo.de> wrote: > > On 10/06 05:49, Andrew Tselischev wrote: > >> On Fri, Oct 06, 2017 at 07:07:04PM +0200, tu...@posteo.de wrote: > >> > Hi, > >> > > >> > The u8g8lib, which contains libraries to drive a great amount of > >> > displays for mainly embedded electronics has a wiki on github, which > >> > can be oficially git-pulled as a local copy...which I did. > >> > > >> > Now I have tons of *.md (markdown) -files instead of html and I > >> > dont know of any handy viewer for these. > >> > > >> > Since I want to update the repo from time to time > >> > I dont want to convert them. > >> > > >> > Is there any recommended quick and clean way to view these files on > the fly as > >> > they would be html? > >> > > >> > Thanks a lot for any help in advance! > >> > Cheers > >> > Meino > >> > > >> > >> Markdown is a markup language that was specifically designed to be > readable in the source. > >> > >> However, if you still find it hard to read, perhaps syntax highlighting > in a fancy > >> text editor can help approximate the intended effects of the markup. > >> > >> Also, there are markdown-to-HTML translators. Some are even included in > portage tree. > >> > > > > > > I dont want to convert the md-files to html, since I want to update > > the repo later (see above). > > The problem are files referencing other files. Reading the md-files > > via vim (for example) would imply to grab all references by hand. > > Fortheremore, tne docs are filled with graphics (for example images > > of the fonts, which can be used), which cannot be displayed with an > > ASCII-editor. > > Formatting is necassary with this docs... > > > > Typically what is done is you render the whole Wiki to HTML, and then > view it in a browser. You don't edit the HTML directly. It should be > possible to generate it incrementally. > > The one catch is that they might be relying on GitHub's integrated > Wiki system. If they are, you might need to install Gollum to process > the markdown files to HTML. > > Cheers, > R0b0t1 > > This is a definite overkill, but I'm using JetBrains' IntelliJ Idea (actually PyCharm) with the markdown plugin. It shows markdown and html side-to-side in the editor.
Anton
