Hid old documentation, pointed to wiki
20 files changed
tree: 664ae2dafce7c0c9fc6ea329b45b50eec5fd5f07
  1. .gitignore
  2. 4.0/
  3. 5.0/
  4. 6.0/
  5. CNAME
  6. README.md
  7. blog.css
  8. bootstrap/
  9. contributors.html
  10. data/
  11. devel/
  12. dist/
  13. fisher-callhome-corpus/
  14. images/
  15. index.html
  16. index5.html
  17. indian-parallel-corpora/
  18. joshua.bib
  19. joshua.css
  20. joshua4.css
  21. joshua6.css
  22. language-packs.csv
  23. language-packs/
  24. publications/
  25. releases.html
  26. releases/
  27. style.css
  28. support/

This directory contains the Joshua web site, including

  • The Joshua decoder main web page
  • The Indian language corpora (in indian-parallel-corpora/)
  • Jekyll code for generating the Joshua end user documentation

The main thing you might want to do (assuming you have write access to this repository) is to add documentation pages. This can be done in two steps:

  1. Write your documentation using Github-supported Markdown or HTML. Create the file in the current directory, using one of the existing files as templates. The top of the file contains a number of lines specifying metadata. The metadata looks like this:

    layout: default.html title: My New Page

    Your content goes here.

    At minimum, you should specify the template to apply (relative to _layouts, probably default.html) and the page's title. Everything below the second set of --- is substituted into the template where {{ content }} is found.

  2. Edit _layouts/default.html, which contains the template file used to host user documentation. You'll want to add a link to your page from the sidebar.

  3. If you also want to edit the main documentation page, you can find that in the file index.md. This file is transformed by Jekyll and placed in userdocs/ alongside everything else.

Note that if you‘re testing on your local machine, you’ll need to install Jekyll. You need to have ruby installed. Then type:

gem install jekyll  # you might need to prepend 'sudo'

You can then type:

jekyll --pygments --safe

to generate the user pages. Do this within a web server and point a recent browser at it. You can also run your own minimal web server with Jekyll. This page has a good Jekyll tutorial.