Command line tool used to parse content written in markdown for our LMS at @Laboratoria (See Laboratoria/bootcamp).
Install as a development dependency in your project:
npm i --save-dev @laboratoria/curriculum-parserYou 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 nor previously installed.
npx @laboratoria/curriculum-parserYou can also install curriculum-parser globally using npm like this:
npm i -g @laboratoria/curriculum-parserIf 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 @laboratoria/curriculum-parserAlternatively you can install using a local clone.
# clone from your own fork
git clone [email protected]:<your-username>/curriculum-parser.git
cd curriculum-parser
npm install
npm linkIf the above command fails, try using sudo:
sudo npm linkIf you installed globally using npm you can simply re-install like so:
npm i -g @laboratoria/curriculum-parserIf 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 [email protected]:Laboratoria/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 masterAfter 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 --rubric [--suffix]
Global options:
-h, --help Show help
-V Show version
curriculum-parser topic topics/javascript \
--repo Laboratoria/bootcamp \
--version 2.5.0 \
--locale es-ES \
--track js \
> "build/topics/javascript.json"curriculum-parser topic topics/javascript \
--repo Laboratoria/bootcamp \
--version 2.5.0 \
--locale pt-BR \
--track js \
--suffix pt \
> "build/topics/javascript-pt.json"curriculum-parser project projects/01-cipher \
--repo Laboratoria/bootcamp \
--version 2.5.0 \
--locale es-ES \
--track js \
--rubric 2.x \
> "build/projects/01-cipher.json"curriculum-parser project projects/01-cipher \
--repo Laboratoria/bootcamp \
--version 2.5.0 \
--locale pt-BR \
--track js \
--rubric 2.x \
--suffix pt \
> "build/projects/01-cipher-pt.json"curriculum-parser topic 00-topics/00-intro-ux \
--repo Laboratoria/curricula-ux \
--version 1.0.0 \
--track ux \
--locale es-EScurriculum-parser topic . \
--repo some-github-user/some-github-repo \
--path . \
--version 1.0.0 \
--track business \
--locale es-ES
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent