How can I have an express endpoint return a README.md file?

Question

I have an express server and I am trying to render my readme at the '/' endpoint. I am looking to simply display the file contents (like github does). I cannot find a straightforward method, i guess to render this as html? Express doesn't seem to support md files.

Currently, I am having issues using the following:

const readme = require('../README.md');

app.get('/', function(req, res) {
  res.send(readme)
});

With the error:

README.md:1
# Express API
^
SyntaxError: Invalid or unexpected token

Which is pointing at the first line of the file.

Does this answer your question? [How to send files with node.js](https://stackoverflow.com/questions/9321027/how-to-send-files-with-node-js) — juzraai, Sep 01 '22 at 07:13
Check out this question https://stackoverflow.com/questions/27971806/returning-rendered-markdown-with-express-and-marked — TD3V, Sep 01 '22 at 07:15
@TD3V this initially did not work because I (dumb) did not install/require marked, but has solved the problem, thanks! — swamptiger24, Sep 01 '22 at 07:21

score 1 · Answer 1 · answered Sep 01 '22 at 07:17

1

require() does not work like this. You can read the file and send the content:

const fs = require("fs");

app.get('/', function(req, res) {
   fs.readFile("../README.md", "utf-8", (err, result) => {
      res.send(result);
   });
});

answered Sep 01 '22 at 07:17

bill.gates

14,145
3
19
47

score 1 · Answer 2 · answered Sep 01 '22 at 07:20

use marked npm package Link

If you want to return a file content then we have to read the file and then we use marked package

 app.get('/' (req,res)=>{
     let filePath = __dirname + '/test.md';
     let file = fs.readFileSync(filePath, 'utf8');
     res.send(marked(file.toString()));
 })

score 1 · Accepted Answer · answered Sep 01 '22 at 07:33

Thanks to TD3V for pointing in the right direction!

Check out this question stackoverflow.com/questions/27971806/…

While this wasn't a complete solution (As It isn't mentioned but I forgot to install Marked and require it, doh), it is one of them.

const fs = require('fs'); 
const { marked } = require('marked');

app.get('/', function(req, res) {
  var readme = '../README.md';
  var output = fs.readFileSync(readme, 'utf8');
  res.send(marked(output.toString()));
});

The other solution pointed out by bill.gates:

require() does not work like this. You can read the file and send the content:

const fs = require("fs");

app.get('/', function(req, res) {
   fs.readFile("../README.md", "utf-8", (err, result) => {
      res.send(result);
   });
});

And while this also works, it is a bit janky with formatting. Thanks guys!

score 0 · Answer 4 · answered Sep 01 '22 at 07:15

According to send() the documentation:

res.send([body])

Sends the HTTP response.
The body parameter can be a Buffer object, a String, an object, Boolean, or an Array.

You are probably looking for sendFile().

res.sendFile(path [, options] [, fn])

Transfers the file at the given path. Sets the Content-Type response HTTP header field based on the filename’s extension. Unless the root option is set in the options object, path must be an absolute path to the file.

score 0 · Answer 5 · answered Sep 01 '22 at 07:17

0

var data =fs.readFileSync('./public/modules/datacollectors/output.pdf');
res.contentType("application/pdf");
res.send(data);

I think you can find your answare in this thread: How to send a pdf file Node/Express?

answered Sep 01 '22 at 07:17

Axander

1
1

How can I have an express endpoint return a README.md file?

5 Answers5

res.send([body])

res.sendFile(path [, options] [, fn])