amber-documentation: what tool is used to author the documentation?

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

amber-documentation: what tool is used to author the documentation?

philippeback
I have forked amber-documentation so that I can contribute some content.

What is the tool used there? So that I can somewhat understand the bits and pieces?

I saw a mention of pygments for the highlightling but how are the other parts working?

How does one get the doc build to see if things are right?

TIA
Phil

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: amber-documentation: what tool is used to author the documentation?

Hannes Hirzel
Phil

It seems that the gh-branch

    https://github.com/amber-smalltalk/amber-documentation/tree/gh-pages

plays an important role. Nicolas is currently working on it today.

If I am not mistaken github does the rest automatically.

Not sure how to do the preview.

--Hannes

On 4/11/14, [hidden email] <[hidden email]> wrote:

> I have forked amber-documentation so that I can contribute some content.
>
> What is the tool used there? So that I can somewhat understand the bits and
> pieces?
>
> I saw a mention of pygments for the highlightling but how are the other
> parts working?
>
> How does one get the doc build to see if things are right?
>
> TIA
> Phil
>
> --
> You received this message because you are subscribed to the Google Groups
> "amber-lang" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [hidden email].
> For more options, visit https://groups.google.com/d/optout.
>

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: amber-documentation: what tool is used to author the documentation?

Herby Vojčík
gh-pages branch is where the files are actually taken from to show on the web.

I'd say if you push changes into your own gh-pages branch, you should be able to see them by pointing to it somehow (but I am just speculating).

Herby

H. Hirzel wrote:

> Phil
>
> It seems that the gh-branch
>
>      https://github.com/amber-smalltalk/amber-documentation/tree/gh-pages
>
> plays an important role. Nicolas is currently working on it today.
>
> If I am not mistaken github does the rest automatically.
>
> Not sure how to do the preview.
>
> --Hannes
>
> On 4/11/14, [hidden email]<[hidden email]>  wrote:
>> I have forked amber-documentation so that I can contribute some content.
>>
>> What is the tool used there? So that I can somewhat understand the bits and
>> pieces?
>>
>> I saw a mention of pygments for the highlightling but how are the other
>> parts working?
>>
>> How does one get the doc build to see if things are right?
>>
>> TIA
>> Phil
>>
>> --
>> You received this m
essage because you are subscribed to the Google Groups
>> "amber-lang" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to [hidden email].
>> For more options, visit https://groups.google.com/d/optout.
>>
>

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: amber-documentation: what tool is used to author the documentation?

Hannes Hirzel
If I would what do do in my fork
https://github.com/hhzl/amber-documentation of the Amber documentation
I would be contributing directly in addition to  filing 'issues'.

https://github.com/amber-smalltalk/amber-documentation/issues

(5 of them since yesterday...)

Please _test_ the documentation which is there so far and
file other issues / questions the documentation should answer there.

--Hannes

On 4/11/14, Herby Vojčík <[hidden email]> wrote:

> gh-pages branch is where the files are actually taken from to show on the
> web.
>
> I'd say if you push changes into your own gh-pages branch, you should be
> able to see them by pointing to it somehow (but I am just speculating).
>
> Herby
>
> H. Hirzel wrote:
>> Phil
>>
>> It seems that the gh-branch
>>
>>      https://github.com/amber-smalltalk/amber-documentation/tree/gh-pages
>>
>> plays an important role. Nicolas is currently working on it today.
>>
>> If I am not mistaken github does the rest automatically.
>>
>> Not sure how to do the preview.
>>
>> --Hannes
>>
>> On 4/11/14, [hidden email]<[hidden email]>  wrote:
>>> I have forked amber-documentation so that I can contribute some content.
>>>
>>> What is the tool used there? So that I can somewhat understand the bits
>>> and
>>> pieces?
>>>
>>> I saw a mention of pygments for the highlightling but how are the other
>>> parts working?
>>>
>>> How does one get the doc build to see if things are right?
>>>
>>> TIA
>>> Phil
>>>
>>> --
>>> You received this m
> essage because you are subscribed to the Google Groups
>>> "amber-lang" group.
>>> To unsubscribe from this group and stop receiving emails from it, send
>>> an
>>> email to [hidden email].
>>> For more options, visit https://groups.google.com/d/optout.
>>>
>>
>
> --
> You received this message because you are subscribed to the Google Groups
> "amber-lang" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [hidden email].
> For more options, visit https://groups.google.com/d/optout.
>

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: amber-documentation: what tool is used to author the documentation?

Nicolas Petton
In reply to this post by philippeback
It uses jekyll: jekyllrb.com

You can test locally with: `jekyll serve`

Cheers,
Nico


[hidden email] writes:

> I have forked amber-documentation so that I can contribute some content.
>
> What is the tool used there? So that I can somewhat understand the bits and
> pieces?
>
> I saw a mention of pygments for the highlightling but how are the other
> parts working?
>
> How does one get the doc build to see if things are right?
>
> TIA
> Phil


--
Nicolas Petton
http://nicolas-petton.fr

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: amber-documentation: what tool is used to author the documentation?

philippeback
On Mon, Apr 14, 2014 at 2:46 PM, Nicolas Petton <[hidden email]> wrote:
It uses jekyll: jekyllrb.com

You can test locally with: `jekyll serve`

Thank you, I didn't knew that tool.

Phil
 

Cheers,
Nico


[hidden email] writes:

> I have forked amber-documentation so that I can contribute some content.
>
> What is the tool used there? So that I can somewhat understand the bits and
> pieces?
>
> I saw a mention of pygments for the highlightling but how are the other
> parts working?
>
> How does one get the doc build to see if things are right?
>
> TIA
> Phil


--
Nicolas Petton
http://nicolas-petton.fr

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: amber-documentation: what tool is used to author the documentation?

sebastianconcept

On Apr 14, 2014, at 10:01 AM, [hidden email] wrote:

It uses jekyll: jekyllrb.com

You can test locally with: `jekyll serve`

Thank you, I didn't knew that tool.

Phil

Me neither and is awesome :)

Thinking in using it for something hehe

Glad to be here!

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: amber-documentation: what tool is used to author the documentation?

Hannes Hirzel
Hello

I installed ruby 1.9.1 and then tried to go for jekyll but got an
error, see log below.
I tried ruby 1.8 as well but jekyll did not install properly.

http://staticsitegenerators.net/

gives an overview of static web generators like jekyll. hexo
(http://hexo.io/index.html, based on nodejs only)  claims to be
largely compatible with Jekyll/Octopress.

However I got

~/amber-documentation $ hexo server
[error] Error: Theme landscape does not exist.

Do you have  suggestions how to proceed, please?
Anyway I realized that Nicolas did a lot of updates in
http://docs.amber-lang.net/ for amber init and the 0.12.4 release.

Regards
Hannes



------------------------------------------------------------------------------------------
hhzl@hhzl-Latitude ~ $ sudo gem install jekyll
[sudo] password for hhzl:
Building native extensions.  This could take a while...
ERROR:  Error installing jekyll:
        ERROR: Failed to build gem native extension.

        /usr/bin/ruby1.9.1 extconf.rb
/usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require': cannot
load such file -- mkmf (LoadError)
        from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
        from extconf.rb:1:in `<main>'


Gem files will remain installed in
/var/lib/gems/1.9.1/gems/fast-stemmer-1.0.2 for inspection.
Results logged to /var/lib/gems/1.9.1/gems/fast-stemmer-1.0.2/ext/gem_make.out
hhzl@hhzl-Latitude ~ $

On 4/14/14, sebastian <[hidden email]> wrote:

>
> On Apr 14, 2014, at 10:01 AM, [hidden email] wrote:
>
>> It uses jekyll: jekyllrb.com
>>
>> You can test locally with: `jekyll serve`
>>
>> Thank you, I didn't knew that tool.
>>
>> Phil
>
> Me neither and is awesome :)
>
> Thinking in using it for something hehe
>
> Glad to be here!
>
> sebastian
>
> o/
>
> --
> You received this message because you are subscribed to the Google Groups
> "amber-lang" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [hidden email].
> For more options, visit https://groups.google.com/d/optout.
>

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.