如何使用 Pug 将 Markdown 文件的目录转换为 HTML 页面？

Question

I'm starting to use Pug templating

I've got a directory with some markdown files that I'd like to turn into HTML pages

legal/
    privacy-policy.md
    refund-policy.md
    terms-of-service.md

So far, I've thought to place a .pug file alongside each

legal/
    privacy-policy.md
  + privacy-policy.pug
    refund-policy.md
  + refund-policy.pug
    terms-of-service.md
  + terms-of-service.pug

The .pug files are all very similar, "boilerplatey" -- they extend the same template:

extends ../layout.pug

block lead
  title Privacy Policy

block content
  .content
    include:markdown-it(linkify) privacy-policy.md

This works for now, but it clearly doesn't scale

How can I do better than this? What's the best way to iterate the .pug boilerplate over each markdown file in the directory?

Answer 1

I'd move all the code to do this back into the route (ie into node.js itself), where you have access to the fs file system library .

To list all the documents do something like this:

router.get('/', function(req, res){

  var folder = 'legal';
  var fs= require('fs');
  var fileList = [];

  fs.readdir(folder, function(err, files){
    files.forEach(function(file){
      fileList.push(file);
    });
  })

  res.render('directory', {"files": fileList});

}

Then to read a file in use a url parameter:

router.get('/:fileName', function(req, res){

  var fileName = 'legal/' + req.params.fileName + '.md';
  var fs= require('fs');

  fs.readFile(fileName, 'utf8', function(err, data) {
    if (err) throw err;

    res.render('contract', {"title": req.params.fileName, "text": data});


});

In your pug template for the contracts just output the variable as rendered using interpolation:

!{text}

You could also get fancy with the title using something like SugarJS titleize which will dynamically create a proper title from the file name.

Answer 2

It's too late an answer, but it might be useful to someone. There is an npm package md-pug-to-html