md2oedx
Translates markdown files and a structure json file into an importable Open Edx course
Last updated 4 months ago by gnoainih .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install md2oedx 
SYNC missed versions from official npm registry.

md2oedx

Translates markdown files and a structure json file into an importable Open Edx course

Install

npm install -g md2oedx

Usage

md2oedx ./source/path ./destination/path

The source path should contain a plain structure of markdown files and a json file named index.json with the course structure. Defaults to current directory.

The output will be written to the destination path. Defaults to current directory.

JSON File Structure

Here is a sample json file that describes a course:

{
  "course": {
    "name": "Course Title",
    "number": "CT",
    "chapter": [{
        "name": "Module 1",
        "sequential": [{
            "name": "Submodule 1",
            "vertical": [{
                "name": "Lesson 1",
                "html": [{
                    "file": "markdown1"
                  }
                ]
              },
              {
                "name": "Lesson 2",
                "html": [{
                  "file": "markdown2"
                }]
              }
            ]
          },
          {
            "name": "Submodule 2",
            "vertical": []
          }
        ]
      },
      {
        "name": "Module 2",
        "sequential": []
      }
    ]
  }
}

Current Tags

  • 0.4.0                                ...           latest (4 months ago)

4 Versions

  • 0.4.0                                ...           4 months ago
  • 0.3.0                                ...           4 months ago
  • 0.2.1                                ...           5 months ago
  • 0.2.0                                ...           5 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 4
Last Day 0
Last Week 0
Last Month 0
Dependencies (10)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |