A tool that sets up a structured markdown project containing basic configuration to generate pdf or other file formats from markdown via pandoc.
By default it is set to create .pdf and .odt files.
You can add new file formats or change the existing ones in the Makefile.
Since it still under development and it was not published to any npm registry, the name of the tool is subject to change.
- gnu make
- pandoc
- git
On a deb-based linux distro you can run:
sudo apt install make pandoc git- Start a new project by runing the command
markdown-helper create [DIRNAME]This creates a new directory containing all the files that you need.
If you don't provide a valid directory name for the
DIRNAMEparam,md2pdfwill create a new directory with the default valuemarkdown-project
- Build the files
On the terminal, go into the recently created directory and run the command
makeYou'll find the newly created files under the dist directory.
Generate all the file formats configured in the Makefile
Generate only .pdf file
Generate only .odt file
Remove all generated files
Inside the project folder you'll find a few files:
This is your markdown document. Since the
Makefile looks for any .md in the current directory,
you can create more files or rename them as you wish.
This is the file used by GNU make to generate your output files. Here you'll find the steps and settings used to generate them. Feel free to add or change the settings as needed.
This is a metadata file which sets a few headers and layout options.
The project is created with an already initialized git repo. Feel free to tweak around.
- Create script sctructure 👍
- Copy template files to new directory 👍
- Init git repo 👍
- First commit 👍
- Handle basic edge cases
- Prevent crash when no values are passed 👍
- Show usage help message
- Publish package on npm