Skip to content
README.md 3.64 KiB
Newer Older
Greg Wilson's avatar
Greg Wilson committed

carlos-tb's avatar
carlos-tb committed
This repository shows how to create a lesson using this
SURF lesson template, and is itself an example of the use of the template.
carlos-tb's avatar
carlos-tb committed
Please see <https://sara-nl.github.io/lesson-example/>
for a rendered version of this material,
including detailed instructions on design, setup, and formatting.

## Quick Instructions
Greg Wilson's avatar
Greg Wilson committed

1.  Do *not* fork this repository directly on GitHub.
Greg Wilson's avatar
Greg Wilson committed
    Instead, please follow the instructions in [the setup instructions][setup]
carlos-tb's avatar
carlos-tb committed
    to create a repository for your lesson by importing.

2.  Once you have created your repository,
    run `bin/lesson_initialize.py` to create standard lesson-specific files.
    You *must* edit several values in `_config.yml`
    so that GitHub Pages will render your lesson correctly.
3.  Please read [the episodes of this lesson][rendered] to format your material.
4.  Please keep the master copy of your lesson in your repository's `gh-pages` branch,
Greg Wilson's avatar
Greg Wilson committed
    since that is what is
Greg Wilson's avatar
Greg Wilson committed
    [automatically published as a website by GitHub][github-pages].
5.  To preview material,
    please run `make serve` from the command line
    to launch Jekyll with the correct parameters,
    or push to your repository's `gh-pages` branch
    and let GitHub take care of the rendering.

6.  Run `make lesson-check` to check that your files follow our formatting rules.

carlos-tb's avatar
carlos-tb committed
7.  If you find an error or omission in this template or in its documentation,
    please [file an issue in this repository][example-issues].

Greg Wilson's avatar
Greg Wilson committed
The layout of this repository is explained in [this site's episodes][rendered].
In brief:
1.  The source for pages that appear as top-level items in the navigation bar
    are stored in the root directory,
    including the home page (`index.md`),
    the reference page (`reference.md`),
    and the setup instructions (`setup.md`).
2.  Source files for lesson episodes are stored in `_episodes`;
    `_episodes/01-xyz.md` generates `/01-xyz/index.html`,
    which can be linked to using `/01-xyz/`.
3.  If you are writing lessons in R Markdown,
    source files go in `_episodes_rmd`.
    You must run `make lesson-rmd` to turn these into Markdown in `_episodes`
    and commit those Markdown files to the repository
    (since GitHub won't run anything except Jekyll to format material).
    You must also commit any figures generated from your lessons,
    which are stored in the `fig` directory.

4.  Files that appear under the "extras" menu are stored in `_extras`.
5.  Figures are stored in the `fig` directory,
    data sets in `data`,
    source code in `code`,
    and miscellaneous files in `files`.
Greg Wilson's avatar
Greg Wilson committed
1.  Run `bin/lesson_initialize.py` to create files
Greg Wilson's avatar
Greg Wilson committed
    that can't be stored in the template repository
    (because they would cause repeated merge conflicts),
Greg Wilson's avatar
Greg Wilson committed
    then edit `_config.yml` as described in
    [the documentation][editing-config].
2.  Run `make lesson-check` at any time
    to check that your lesson files follow our formatting rules.
    If you come across formatting issues that the checker doesn't report,
carlos-tb's avatar
carlos-tb committed
    please [file an issue][issues].

3.  For a list of helpful commands run `make` in this directory.
Greg Wilson's avatar
Greg Wilson committed
    If you are looking for things to work on,
    please see [the list of issues for this repository][issues].

[collections]: https://jekyllrb.com/docs/collections/
carlos-tb's avatar
carlos-tb committed
[editing-config]: https://sara-nl.github.io/lesson-example/03-organization/
[example-issues]: https://github.com/sara-nl/lesson-example/issues/
Greg Wilson's avatar
Greg Wilson committed
[github-pages]: https://help.github.com/articles/creating-project-pages-manually/
carlos-tb's avatar
carlos-tb committed
[issues]: https://github.com/sara-nl/lesson-example/issues
[rendered]: https://sara-nl.github.io/lesson-example/
[setup]: https://sara-nl.github.io/lesson-example/setup.html