7:55 a.m.
Github's wiki asciidoc doesn't play nicely with syntax highlighting: displays all
the code with the same plain color, instead of highlighting the syntax elements like the
IDEs do.
E.g. the sample code provided in the wiki asciidoc help:
.python.py
[source,python]
----
# i just wrote a comment in python
print "something"
# and maybe one more
----
renders like:
http://screencast.com/t/k6JVQrWQ4
Whilst the markdown equivalent:
```python
# i just wrote a comment in python
print "something"
# and maybe one more
```
renders as expected:
http://screencast.com/t/YLMhs31Jm
I think this has been a problem for quite a while now:
https://github.com/gollum/gollum/issues/280
Does anyone see any problem with allowing both markdown and asciidoc editors for our wiki?
They both have pretty basic syntax and markdown seems to be better integrated (I guess
that's why it's also the default editor).
Cheers,
--
Mircea Markus
Infinispan lead (www.infinispan.org)
11:49 a.m.
I only suggested AsciiDoc to be consistent with the markup used for our
documentation. Having two different markup syntaxes in use for the project
could get annoying... but yes, I agree that the lack of syntax highlighting
on the wiki can be even more annoying.
On 30 October 2013 12:55, Mircea Markus <mmarkus(a)redhat.com> wrote:
Github's wiki asciidoc doesn't play nicely with syntax
highlighting:
displays all the code with the same plain color, instead of highlighting
the syntax elements like the IDEs do.
E.g. the sample code provided in the wiki asciidoc help:
.python.py
[source,python]
----
# i just wrote a comment in python
print "something"
# and maybe one more
----
renders like:
http://screencast.com/t/k6JVQrWQ4
Whilst the markdown equivalent:
```python
# i just wrote a comment in python
print "something"
# and maybe one more
```
renders as expected:
http://screencast.com/t/YLMhs31Jm
I think this has been a problem for quite a while now:
https://github.com/gollum/gollum/issues/280
Does anyone see any problem with allowing both markdown and asciidoc
editors for our wiki? They both have pretty basic syntax and markdown seems
to be better integrated (I guess that's why it's also the default editor).
Cheers,
--
Mircea Markus
Infinispan lead (www.infinispan.org)
_______________________________________________
infinispan-dev mailing list
infinispan-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/infinispan-dev
2:26 p.m.
On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik(a)infinispan.org> wrote:
I only suggested AsciiDoc to be consistent with the markup used for
our documentation. Having two different markup syntaxes in use for the project could get
annoying... but yes, I agree that the lack of syntax highlighting on the wiki can be even
more annoying.
If it's only that let's just use markup as it is more mature on github. I'll
update the docs to state that.
Cheers,
--
Mircea Markus
Infinispan lead (www.infinispan.org)
5:39 a.m.
On 30 October 2013 19:26, Mircea Markus <mmarkus(a)redhat.com> wrote:
On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik(a)infinispan.org> wrote:
> I only suggested AsciiDoc to be consistent with the markup used for our
documentation. Having two different markup syntaxes in use for the project
could get annoying... but yes, I agree that the lack of syntax highlighting
on the wiki can be even more annoying.
If it's only that let's just use markup as it is more mature on github.
I'll update the docs to state that.
You mean Markdown?
5:56 a.m.
If you use MarkKonami, you get a hidden bonus.
On Thu 2013-10-31 10:39, Manik Surtani wrote:
On 30 October 2013 19:26, Mircea Markus <mmarkus(a)redhat.com>
wrote:
>
> On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik(a)infinispan.org> wrote:
>
> > I only suggested AsciiDoc to be consistent with the markup used for our
> documentation. Having two different markup syntaxes in use for the project
> could get annoying... but yes, I agree that the lack of syntax highlighting
> on the wiki can be even more annoying.
>
> If it's only that let's just use markup as it is more mature on github.
> I'll update the docs to state that.
>
You mean Markdown?
_______________________________________________
infinispan-dev mailing list
infinispan-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/infinispan-dev
6:24 a.m.
On Oct 31, 2013, at 10:56 AM, Emmanuel Bernard <emmanuel(a)hibernate.org> wrote:
If you use MarkKonami, you get a hidden bonus.
MarkKonami? :-)
On Thu 2013-10-31 10:39, Manik Surtani wrote:
> On 30 October 2013 19:26, Mircea Markus <mmarkus(a)redhat.com> wrote:
>
>>
>> On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik(a)infinispan.org> wrote:
>>
>>> I only suggested AsciiDoc to be consistent with the markup used for our
>> documentation. Having two different markup syntaxes in use for the project
>> could get annoying... but yes, I agree that the lack of syntax highlighting
>> on the wiki can be even more annoying.
>>
>> If it's only that let's just use markup as it is more mature on github.
>> I'll update the docs to state that.
>>
>
> You mean Markdown?
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev
_______________________________________________
infinispan-dev mailing list
infinispan-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/infinispan-dev
Cheers,
--
Mircea Markus
Infinispan lead (www.infinispan.org)
9:03 a.m.
On Thu 2013-10-31 11:24, Mircea Markus wrote:
On Oct 31, 2013, at 10:56 AM, Emmanuel Bernard <emmanuel(a)hibernate.org> wrote:
> If you use MarkKonami, you get a hidden bonus.
MarkKonami? :-)
Markup, Markup, Markdown, Markdown, Markleft, Markright, Markleft, Markright, Markb, Marka
= Markkonami
https://en.wikipedia.org/wiki/Konami_Code
6:25 a.m.
On Oct 31, 2013, at 10:39 AM, Manik Surtani <manik(a)infinispan.org> wrote:
On 30 October 2013 19:26, Mircea Markus <mmarkus(a)redhat.com>
wrote:
On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik(a)infinispan.org> wrote:
> I only suggested AsciiDoc to be consistent with the markup used for our
documentation. Having two different markup syntaxes in use for the project could get
annoying... but yes, I agree that the lack of syntax highlighting on the wiki can be even
more annoying.
If it's only that let's just use markup as it is more mature on github. I'll
update the docs to state that.
You mean Markdown?
yes :-)
Cheers,
--
Mircea Markus
Infinispan lead (www.infinispan.org)
4:40 a.m.
I find the lack of syntax highlighting a small thing TBH. You can always take the code,
paste it in a gist and put the link in the design document.
I do however find asciidoc much better for structuring complex documentation. For example,
adding a bullet or numbered point section with code/quote sections inside.
Personally, I'd leave it up to individual contributors to decide what they prefer in
terms of markup language, although I agree that a preferable markup language should be
defined in the documentation.
Cheers,
On Oct 30, 2013, at 8:26 PM, Mircea Markus <mmarkus(a)redhat.com> wrote:
On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik(a)infinispan.org> wrote:
> I only suggested AsciiDoc to be consistent with the markup used for our
documentation. Having two different markup syntaxes in use for the project could get
annoying... but yes, I agree that the lack of syntax highlighting on the wiki can be even
more annoying.
If it's only that let's just use markup as it is more mature on github. I'll
update the docs to state that.
Cheers,
--
Mircea Markus
Infinispan lead (www.infinispan.org)
_______________________________________________
infinispan-dev mailing list
infinispan-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/infinispan-dev
--
Galder Zamarreño
galder(a)redhat.com
twitter.com/galderz
Project Lead, Escalante
http://escalante.io
Engineer, Infinispan
http://infinispan.org
11:54 a.m.
On Nov 4, 2013, at 10:40 AM, Galder Zamarreño <galder(a)redhat.com> wrote:
I find the lack of syntax highlighting a small thing TBH. You can
always take the code, paste it in a gist and put the link in the design document.
As long as you do that, +1.
The document is read way more many times than written and I think syntax highlighting
really helps with redability.
I do however find asciidoc much better for structuring complex documentation. For
example, adding a bullet or numbered point section with code/quote sections inside.
Does that actually work on github? asciidoc also provides syntax highlighting, but the
github renderer doesn't take it into account.
Personally, I'd leave it up to individual contributors to decide what they prefer in
terms of markup language, although I agree that a preferable markup language should be
defined in the documentation.
Sure, both of them are pretty straight forward. Let's used both then (document
updated).
Cheers,
On Oct 30, 2013, at 8:26 PM, Mircea Markus <mmarkus(a)redhat.com> wrote:
>
> On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik(a)infinispan.org> wrote:
>
>> I only suggested AsciiDoc to be consistent with the markup used for our
documentation. Having two different markup syntaxes in use for the project could get
annoying... but yes, I agree that the lack of syntax highlighting on the wiki can be even
more annoying.
>
> If it's only that let's just use markup as it is more mature on github.
I'll update the docs to state that.
>
> Cheers,
> --
> Mircea Markus
> Infinispan lead (www.infinispan.org)
>
>
>
>
>
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev
--
Galder Zamarreño
galder(a)redhat.com
twitter.com/galderz
Project Lead, Escalante
http://escalante.io
Engineer, Infinispan
http://infinispan.org
_______________________________________________
infinispan-dev mailing list
infinispan-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/infinispan-dev
Cheers,
--
Mircea Markus
Infinispan lead (www.infinispan.org)
11:40 a.m.
On Nov 4, 2013, at 6:54 PM, Mircea Markus <mmarkus(a)redhat.com> wrote:
On Nov 4, 2013, at 10:40 AM, Galder Zamarreño
<galder(a)redhat.com> wrote:
> I find the lack of syntax highlighting a small thing TBH. You can always take the
code, paste it in a gist and put the link in the design document.
As long as you do that, +1.
The document is read way more many times than written and I think syntax highlighting
really helps with redability.
Nothing helps code readability more than a PR :)
>
> I do however find asciidoc much better for structuring complex documentation. For
example, adding a bullet or numbered point section with code/quote sections inside.
Does that actually work on github?
^ Sure it does: https://github.com/galderz/rolling/blob/master/README.asciidoc
asciidoc also provides syntax highlighting, but the github renderer
doesn't take it into account.
>
> Personally, I'd leave it up to individual contributors to decide what they prefer
in terms of markup language, although I agree that a preferable markup language should be
defined in the documentation.
Sure, both of them are pretty straight forward. Let's used both then (document
updated).
>
> Cheers,
>
> On Oct 30, 2013, at 8:26 PM, Mircea Markus <mmarkus(a)redhat.com> wrote:
>
>>
>> On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik(a)infinispan.org> wrote:
>>
>>> I only suggested AsciiDoc to be consistent with the markup used for our
documentation. Having two different markup syntaxes in use for the project could get
annoying... but yes, I agree that the lack of syntax highlighting on the wiki can be even
more annoying.
>>
>> If it's only that let's just use markup as it is more mature on github.
I'll update the docs to state that.
>>
>> Cheers,
>> --
>> Mircea Markus
>> Infinispan lead (www.infinispan.org)
>>
>>
>>
>>
>>
>> _______________________________________________
>> infinispan-dev mailing list
>> infinispan-dev(a)lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/infinispan-dev
>
>
> --
> Galder Zamarreño
> galder(a)redhat.com
> twitter.com/galderz
>
> Project Lead, Escalante
> http://escalante.io
>
> Engineer, Infinispan
> http://infinispan.org
>
>
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev
Cheers,
--
Mircea Markus
Infinispan lead (www.infinispan.org)
_______________________________________________
infinispan-dev mailing list
infinispan-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/infinispan-dev
--
Galder Zamarreño
galder(a)redhat.com
twitter.com/galderz
Project Lead, Escalante
http://escalante.io
Engineer, Infinispan
http://infinispan.org
3835
days inactive
3841
days old
infinispan-dev@lists.jboss.org
10 comments
4 participants
participants (4)
-
Emmanuel Bernard -
Galder Zamarreño -
Manik Surtani -
Mircea Markus