[SOLVED] Github markdown editor?

turboscrew · 11-28-2015, 06:50 AM

Which editor do you use for writing Readmes for github?

I'd like to know if there is such an editor already in the repos that can show the file before it gets pushed.

navigium · 11-28-2015, 07:24 AM

Quote:

Originally Posted by turboscrew

Which editor do you use for writing Readmes for github?

I'd like to know if there is such an editor already in the repos that can show the file before it gets pushed.

You could try Atom, a nodejs based editor. It has a Markdown preview mode. I personally use Emacs, I'm sure there is a way to compile the markdown from within Emacs. After all, emacs is a full OS without an usable editor

Edit: Forgot the link to SBo: http://slackbuilds.org/repository/14...elopment/atom/

turboscrew · 11-28-2015, 07:36 AM

I'll try. Sbopkg knows it. The 500MB gets me worried a bit, though...

How does Emacs handle it? Add-ons needed? Can it show the result?
(I've already written some stuff, but don't want to publish it before I can see if it's OK.)

navigium · 11-28-2015, 07:41 AM

Quote:

Originally Posted by turboscrew

I'll try. I'm sure sbopkg finds it.
How does Emacs handle it? Add-ons needed? Can it show the result?

I haven't used it in a while because I usually stick to asciidoc. But I think the Emacs markdown mode[1] compiles the markdown it you hit C-c C-c. But you need markdown installed and a web browser to preview the outcome.

[1]: http://jblevins.org/projects/markdown-mode/

moesasji · 11-28-2015, 08:00 AM

Quote:

Originally Posted by navigium

I haven't used it in a while because I usually stick to asciidoc. But I think the Emacs markdown mode[1] compiles the markdown it you hit C-c C-c. But you need markdown installed and a web browser to preview the outcome.

It might be easier to start with a Emacs Starter-package that includes Markdown mode. My favorite: spacemacs. At the moment still a bit of a moving target, but works extremely well without having to spend ages setting up emacs to do what I want it to do.

turboscrew · 11-28-2015, 08:34 AM

It's the previewing the outcome I'm mostly interested in.
Tried with Firefox/Markdown Viewer, but there is some pseudo code that the basic markdown doesn't show right. Any idea about a Firefox plugin that could handle github markdown?

kikinovak · 11-28-2015, 09:03 AM

Quote:

Originally Posted by turboscrew

Which editor do you use for writing Readmes for github?

Vim.

https://github.com/kikinovak/microlinux

turboscrew · 11-28-2015, 09:13 AM

I wrote a readme with Geany, but I just don't know what it looks like when pushed into github.
I also tried a GFM-reader plugin for eclipse (Kepler): The window opened, but nothing appeared in it.

moesasji · 11-28-2015, 09:36 AM

Quote:

Originally Posted by turboscrew

It's the previewing the outcome I'm mostly interested in.

Did you actually look at Spacemacs? In other words it allows you to preview markdown output for the file you are editing.

@Kinovak: I actually switched from Vim to Spacemacs as it does a very good job of feeling like Vim with the power of the emacs plugins.

turboscrew · 11-28-2015, 09:40 AM

Quote:

Originally Posted by moesasji

Did you actually look at Spacemacs? In other words it allows you to preview markdown output for the file you are editing.

@Kinovak: I actually switched from Vim to Spacemacs as it does a very good job of feeling like Vim with the power of the emacs plugins.

Not yet. I'm installing Atom to see if it works.
I have tried a couple of chrome plugins in chromium, but couldn't make any of them to work.

turboscrew · 11-28-2015, 09:45 AM

I'm working on a bare metal program and the readme is for that, but I don't want to make that readme.md a life's work. If it's getting too laborous I'll either stick with the text version or push the md unchecked.

I've been writing bare metal standalone gdb agent for Rapberry Pi 2B and I'm geting frustrated enough with that. I really don't need more problems with each tool.
(Neither RPi 2B nor gdb are very abundant with clear documentation. ;-) )

And BTW, the readme really looks messy:
https://github.com/turboscrew/rpi_stub

turboscrew · 11-28-2015, 10:14 AM

I think I'll try spacemacs next...

Quote:

Unable to download https://www.atom.io/api/packages/lan....14.0/tarball: connect ETIMEDOUT

;-)

turboscrew · 11-28-2015, 10:37 AM

About spacemacs, what's there in "orgmode.org" port 80? Spacemacs has waited for something for a while.

turboscrew · 11-28-2015, 10:44 AM

Already installing bind-key... I wish I could put all applications somewhere far away cloud. Then I could enjoy the network lags all the time... ;-D
(And I hope the storm outside doesn't start making problems - or damage in the neighbourhood...)

moesasji · 11-28-2015, 10:48 AM

Quote:

Originally Posted by turboscrew

About spacemacs, what's there in "orgmode.org" port 80? Spacemacs has waited for something for a while.

I've never seen this, but looks like you hit this bug. Essentially Spacemacs looks for updates during startup and in this case it can't find one of the servers. There is a fix in devel, so the best approach might be to use the development branch for now.

edit) I see you posted that you got past the hurdle, so ignore the suggestion. The good news is that once it is installed it is fast....just installing all the plugins initially takes a longish time.