@kaudal/curriculum-parser

@kaudal/curriculum-parser

Command line tool used to parse content written in markdown for our courses in Aprende at @kaudal

Installation

Install as a development dependency in your project:

npm i --save-dev @kaudal/curriculum-parser

You should now be able to run it with npx:

npx curriculum-parser # when already installed in project

# or alternatively using full package name (with org)
# this works even if not previously installed.
npx @kaudal/curriculum-parser

You can also install curriculum-parser globally using npm like this:

npm i -g @kaudal/curriculum-parser

If you get a permission error please try using sudo (you may need admin permissions depending on your node installation).

# using `sudo` (only if previous step failed)
sudo npm i -g @kaudal/curriculum-parser

Alternatively you can install using a local clone.

# clone from your own fork
git clone [e-mail]:<your-username>Kaudal/curriculum-parser.git
cd curriculum-parser
npm install
npm link

If the above command fails, try using sudo:

sudo npm link

Upgrade

If you installed globally using npm you can simply re-install like so:

npm i -g @kaudal/curriculum-parser

If you chose to install using a local clone, you can update your clone to upstream master:

# go into local copy of repo
cd curriculum-parser
# if not yet added a reference to upstream remote we add it
git remote add upstream [e-mail]:Kaudal/curriculum-parser.git
# fetch changes and merge upstream/master into local master
git fetch upstream
git merge upstream/master
# you may also want to push changes to your fork
git push origin master

Usage

After installing globally (or linking with npm link) you should have the curriculum-parser command available in your PATH.

Usage: curriculum-parser [command] [options]

Commands:

  help
  topic <dir> --repo --version --locale --track [--suffix]
  project <dir> --repo --version --locale --track [--lo=some/dir] [--suffix]

Global options:

  -h, --help        Show help
  -V                Show version

Example

Parse a topic (course) in some arbitrary directory

curriculum-parser topic . \
  --repo some-github-user/some-github-repo \
  --path . \
  --version 1.0.0 \
  --track business \
  --locale es-ES