Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
HTML CSS Other
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
4.0 Restored old layout for 4.0 documentation
5.0 Merge branch '6.0'
6.0 updated pipeline doc for 6.0.3 release
_data updated pipeline doc for 6.0.3 release
_layouts Added jekyll variables to store version and other info
bootstrap Updated layout using bootstrap.js
data Fixed titles and PDF link, deleted dummy "Scores" section
devel Added link to developer docs
dist Beginning 6.0 documentation
fisher-callhome-corpus Added Fisher-Callhome and moved datasets around
images made logos display nicer
indian-parallel-corpora Added Fisher-Callhome and moved datasets around
language-packs Added file sizes
publications Modifying the software download instructions - deleted the swig requi…
releases fixed current link
.gitignore Beginning 6.0 documentation
CNAME added CNAME record, fixed link typo
README.md typo correction
_config.yml Fixing redirect
blog.css Beginning 6.0 documentation
contributors.md Updated for Joshua 6
index.md Added jekyll variables to store version and other info
index5.html Updated for Joshua 6
joshua.bib Added the original joshua.bib file
joshua.css Updated documentation for 5.0 release
joshua4.css Dummy commit
joshua6.css adjusted margin
language-packs.csv Updated for Joshua 6
releases.md skeletal release notes for 5.0
style.css Added the original joshua.bib file

README.md

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.

Something went wrong with that request. Please try again.