/my-oer-test

MIT LicenseMIT

Template for OER

This is a template for open and freely licensed texts that delivers appealing, and depending on the template, multimedia results. It additionally automates a lot of laborious work during creation. This template can be used for courses or modules as well as for all sorts of texts, including student research papers or theses.

  • generates metadata in HTML headers for OER repositories and Google search
  • automatically creates license notices for Wikimedia images with machine-readable notices according to CC REL
  • inserts license notice in generated documents

With every save (commit) the documents are generated and available via:

or directly

Use this template

  1. Create a new repository based on this template
    • click the green button Use this template or click here
    • enter a name for the new repository and click on Create repository from template
  2. In settings -> pages: choose GitHub Actions as Source
  3. Adjust metadata.yml
    • edit manually or
    • create metadata with generator and copy/paste content into metadata.yml
  4. Output files will be generated automatically and available after aprox. 1 min
  5. Create your content in Markdown files (default chapterXX.md)
  6. You can overwrite this README.md as you like

Configuration

See https://gitlab.com/TIBHannover/oer/markdown-pandoc-processor#options

License notice

This template for OER courses is released under CC-0 / public domain. The content of the document is subject to the respective license as indicated at the end of the generated files or in the metadata.yml.