DEV Community

loading...
Cover image for Building a project from markdown

Building a project from markdown

fennecdjay profile image Jérémie Astor ・1 min read

Building a project from markdown

This post is intented as an helper for my next one 😄

It aims to briefly demonstrate how one can use mdr
to build a project from a mdr file, which happens to be a markdown file
with few annotations.

Since I not yet comfortable with technical nor post writing,
I'm leaving a (hopefully commented) script do the explanation.
Please read before running 😄

# create a new directory and cd into it
mkdir GwionTest
cd GwionTest

# clone, build and install mdr
git clone https://github.com/fennecdjay/mdr
cd mdr
make
sudo make install

# get back to GwionTest directory
cd ..

# get the mdr file
curl https://raw.githubusercontent.com/fennecdjay/devto.sh/master/mdr/HelloGwion.mdr -o HelloGwion.mdr

# run mdr on the file, thus building the project
# set the BROWSER variable to the executable of the browser you use
# e.g: BROWSER=dissenter-browser mdr HelloGwion.mdr
BROWSER=<your browser here> mdr HelloGwion.mdr
Enter fullscreen mode Exit fullscreen mode

I you see any issues with the wording or anything in this post or the mdr file,
please let me know.

Discussion (0)

pic
Editor guide