KDLearn is a series of Markdown files which are compiled to HTML. This compiling is handled by code found within this directory.
Note that KDLearn's project structure is content first. This means that when someone visits the repo, they immediately see the content and know how to write it. They don't have to learn our implementation or even have a clue how to compile it. They only have to know Markdown.
So, if you're looking to contribute features to KDLearn, make sure that implementation stays entirely within this directory. This includes all SASS, layout images, javascript, etc.
A global installation of gulp, and varying node packages are required. From
the kdlearn directory, type the following:
npm install -g gulp
cd .metalsmith
npm install
With Gulp installed, simply run the following command, to compile the entire project into HTML.
cd .metalsmith
gulp
The ./build directory will contain all of the compiled html, css, and any
static resources (such as images/etc) from the markdown directory.
If you want to preview the compiled site, open a new Koding Terminal tab and run the following:
cd .metalsmith
gulp preview
This will run a small HTTP Server on Port 8000, ie: http://you.kd.io:8000.
Keep this tab open, and in a different Koding Terminal tab run your gulp
command from above. Each time you compile the site, this will show your
compiled site.
To have your Markdown compiled as you write your documents, run the following commands:
cd .metalsmith
gulp watch
This, in combination with the preview command above, will compile the site each time you change the Markdown.
Of course, you can skip the cd command if you're already in the source
directory.
The gulp command needs to be run from the kdlearn/.metalsmith directory.
Assuming that you're in the kdlearn directory, navigate into the
.metalsmith directory with the following command:
cd .metalsmith
If you failed to install the dependencies, or if the dependencies have
changed, your gulp command may fail with verbose and confusing errors.
There's no telling what the errors will say, because there is no telling what
exactly will be missing when you see it.
Regardless, if you're running into weird errors, try simply installing the dependencies again. If you're up to date, nothing will be installed. If you're missing something, it will be installed. See the installation instructions above for instructions.