https://github.com/mediacomem/courses-md
Write courses in Markdown and publish them as HTML slides
https://github.com/mediacomem/courses-md
Last synced: about 1 year ago
JSON representation
Write courses in Markdown and publish them as HTML slides
- Host: GitHub
- URL: https://github.com/mediacomem/courses-md
- Owner: MediaComem
- License: mit
- Created: 2017-10-09T14:10:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-03T10:54:18.000Z (over 8 years ago)
- Last Synced: 2025-02-14T17:43:31.510Z (over 1 year ago)
- Language: JavaScript
- Size: 1.19 MB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Courses 
> Write courses in Markdown and publish them as HTML slides.
[](https://badge.fury.io/js/courses-md)
- [Requirements](#requirements)
- [Getting started](#getting-started)
- [What sorcery is this?](#what-sorcery-is-this)
- [Documentation](#documentation)
- [Examples](#examples)
## Requirements
* [Git][git] 2+
* [Node.js][node] 8+
## Getting started
Install the [Yeoman generator][generator-courses-md] to get started:
```bash
npm install -g yo generator-courses-md
```
Create a directory in which to write your courses. Go into it and run the generator:
```bash
mkdir courses
cd courses
yo courses-md
```
Run `yo courses-md --help` or read the [project's documentation][generator-courses-md] to see what options are available.
## What sorcery is this?
Courses MD allows you to write Markdown which will be automatically transformed
into HTML slides.
The resulting HTML files are [Remark][remark] slides and Courses MD uses
[md2remark][md2remark] to process the Markdown, so you should familiarize
yourself with these 2 tools to know what you can do.
## Documentation
The documentation is written with Courses MD itself:
* Read it [as Markdown on GitHub](https://github.com/MediaComem/courses-md/tree/master/subjects/documentation#readme)
* Read it [as HTML slides on GitHub Pages](https://mediacomem.github.io/courses-md/latest/subjects/documentation/)
## Examples
Take a look at these [COMEM+ web development courses][comem-webdev] which were written with Courses MD, for example:
* [Git Branching][comem-webdev-git-branching]
* [REST APIs Introduction][comem-webdev-rest]
[comem-webdev]: https://github.com/MediaComem/comem-webdev#subjects
[comem-webdev-git-branching]: https://mediacomem.github.io/comem-webdev-docs/2017/subjects/git-branching/
[comem-webdev-rest]: https://mediacomem.github.io/comem-webdev-docs/2017/subjects/rest/
[generator-courses-md]: https://github.com/MediaComem/generator-courses-md
[generator-courses-md-docs]: https://github.com/MediaComem/generator-courses-md#readme
[git]: https://git-scm.com
[md2remark]: https://github.com/AlphaHydrae/md2remark
[node]: https://nodejs.org
[remark]: https://remarkjs.com/#1