[play-framework] play-2.0 how to access documentation

137 views
Skip to first unread message

green

unread,
Nov 16, 2011, 8:19:09 PM11/16/11
to play-framework
Hi,

There are a deck of files in the documentation folder. Problem is I don't know how to access them.

In 1.0 I can view document by starting any project and go to http://localhost:9000/@documentation. This doesn't work with 2.0 however.

Regards,
Green

Peter Hilton - committer (Lunatech)

unread,
Nov 17, 2011, 5:09:22 AM11/17/11
to play-fr...@googlegroups.com
This is a work in progress, because there’s no ‘docviewer’ yet, as in Play 1, but it is still possible, because documentation/manual is a copy of the github wiki, which means you can browse it locally as follows.

1. Commit the files into a ad-hoc local git repository:

cd documentation/manual
git init
git add .
git commit -m 'docs'

2. Install and run gollum - https://github.com/github/gollum

sudo gem install gollum
gollum

3. View the docs in your browser at http://localhost:4567/

christian sarnataro

unread,
Nov 17, 2011, 6:35:41 AM11/17/11
to play-fr...@googlegroups.com
You can also see the wiki online.

thenrion

unread,
Nov 29, 2011, 4:54:36 PM11/29/11
to play-framework
Thank's for the help.
Unfortunately most of the home page links don't display correctly:
"ArgumentError at /Installing
Requires a Node, NodeSet or String argument, and cannot accept a
NilClass. (You probably want to select a node from the Document with
at() or search(), or create a new Node via Node.new().) ..."

On Nov 17, 11:09 am, "Peter Hilton - committer (Lunatech)"


<peter.hil...@gmail.com> wrote:
> This is a work in progress, because there’s no ‘docviewer’ yet, as in Play
> 1, but it is still possible, because documentation/manual is a copy of the
> github wiki, which means you can browse it locally as follows.
>
> 1. Commit the files into a ad-hoc local git repository:
>
> cd documentation/manual
> git init
> git add .
> git commit -m 'docs'
>

> 2. Install and run gollum -https://github.com/github/gollum

ttsui

unread,
Mar 30, 2012, 12:27:03 AM3/30/12
to play-fr...@googlegroups.com
I also hit this problem and resolved it by install Pygments. This error is mentioned in Gollum's Wiki see it for more details.

Tony
Reply all
Reply to author
Forward
0 new messages