search

asciidoctor / atom-language-asciidoc

⚛ AsciiDoc language package for the Atom editor.
https://atom.io/packages/language-asciidoc
MIT License
42 stars 20 forks source link

doc: project organization and getting started #120

Closed nicorikken closed 8 years ago

nicorikken commented 8 years ago

To add labels and provide a guidance for getting started (sorry, somewhat of a combined PR). Labels based on #105

I was trying to go for some highlighting in accordance with the GitHub label colors. Unfortunately I couldn't easy find out how to do that, based on the Asciidoctor manual. Can I get some writing/coding advice?

nicorikken commented 8 years ago

Am I correct in saying that you can call atom -d . in the checkout out directory for development? Personally I have symlinked my checkout into ~/.atom/packages

mojavelinux commented 8 years ago

I was trying to go for some highlighting in accordance with the GitHub label colors.

You'll have to resort to images. GitHub does not allow the use of colorized text in an AsciiDoc file (or any markup language for that matter). One creative way to do it is to link to a badge service that lets you create an SVG with custom text and color.

For example:

mojavelinux commented 8 years ago

You still have to symlink it first.

apm link
atom -d .
nicorikken commented 8 years ago

You'll have to resort to images. GitHub does not allow the use of colorized text in an AsciiDoc file

I'll leave this for now then.

ldez commented 8 years ago

apm link -d otherwise the package is bound even outside the dev context

nicorikken commented 8 years ago

Alright, changed it.

nicorikken commented 8 years ago

ready to merge?

mojavelinux commented 8 years ago

I left some comments inline. Once you address those, I'm ready to endorse.

nicorikken commented 8 years ago

This latest commit should fix it. Please verify.

mojavelinux commented 8 years ago

Beautiful! :+1: