This repository is now archived. It previously generated the documentation for https://docs.learninglocker.net which now redirects to https://learninglocker.atlassian.net/wiki/spaces/DOCS/overview hosted by Learning Pool's account on Confluence.

Documentation for Learning Locker.

Learning Locker is copyright Learning Pool

Users

Please view our documentation site.

Developers

You may contribute to this project via issues and pull request, however, please see the guidelines before doing so. More information about how you can get involved can be found on the Learning Locker website.

Getting Started

1. Open the file you wish to edit on Github.
2. Edit the file.
3. Enter a "commit message" (found below the edited file).
4. Click "Propose file changes" (found below the edited file).

Alternatively:

1. Fork the repository.
2. Change the markdown documentation files.
3. Commit and push your changes to Github.
4. Create a pull request on Github (ensuring that you follow the guidelines).

Development

1. Install Ruby
2. Install Bundler
3. Run bundler install
4. Run jekyll server --watch
5. Go to http://127.0.0.1:4000 in your browser

For each change in the src files jekyll will automatically recompile the dist files.

Note that the documentation site is generated using Jekyll. To learn more about the repository structure, please view the Jekyll documentation.