tools: added remark-frontmatter

[benhalverson]

remark-frontmatter allows the use of frontmatter metadata in markdown
files. The purpose of this change is so nodejs.dev can parse the docs with graphql and frontmatter markdown.

In my brief testing adding this change doesn't break nodejs.org

[targos]

Does it change anything in the built docs or it's just to prepare for future changes?

[benhalverson]

This is for future changes. It's not changing any existing docs at the moment.

[targos]

@nodejs/documentation

[aduh95]

What would be the use of this in our docs? Do you have an example would be nice, or maybe a link to a thread where this was discussed?

[benhalverson]

@aduh95 This change is for nodejs.dev that will eventually replace nodejs.org. The nodejs.org docs site would ignore this change.
https://github.com/nodejs/nodejs.dev
An example

---title: Bufferurl: buffercategory: docslang: en---
<currentbuffercontent...>

it's been discussed in website-redesign meetings. I've asked in the openJS slack here.

I'll have a working demo later today.

[benhalverson]

Here's a demo without the frontmatter changes. I'm using the i18n npm package from node/i18n they have a nightly cron job that gets the latest docs.
PR: nodejs/nodejs.dev#1344
Demo: https://staging.nodejs.dev/1344/docs-demo

with this front matter change I can more easily add a slug/id after /docs. An existing implementation we have is for the blog posts that don't yet exist here.

https://github.com/nodejs/nodejs.dev/blob/master/gatsby-node.js#L136-L141

[aduh95]

@benhalverson are you planning to open other PRs to add frontmatter metadata headers to the doc/api markdown files in the near future? I'd prefer we hold this PR until there's at least one PR ready to change an actual markdown file.

[benhalverson]

@aduh95 Yes I plan to do the doc PR's. Do I need to create a issue first?

[aduh95]

I don't think an issue is necessary – or at least, it wouldn't be very useful in this repo imho given this kind of change is visible to nodejs.dev users only.

[zeke]

cc @nodejs/i18n 👀

[RichardLitt]

Sounds like a good move to me, as far as i18n goes.

[benhalverson]

Thanks for the approval I'll get that merge conflict fixed!

[benhalverson]

Do I need to do anything about the failed checks?

[DerekNonGeneric]

@benhalverson, that CI failure does not appear to be related, and am not clear on why that happened, but the PR looks good to me, so let's get this thing landed for you already.

[github-actions]

Commit Queue failed

- Loading data for nodejs/node/pull/38717
✔ Done loading data for nodejs/node/pull/38717
----------------------------------- PR info ------------------------------------
Title tools: added remark-frontmatter (#38717)
⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch benhalverson:docs-frontmatter -> nodejs:master
Labels commit-queue, doc, tools
Commits 1
- tools: added remark-frontmatter
Committers 1
- Ben Halverson PR-URL: https://github.com/nodejs/node/pull/38717
Reviewed-By: James M Snell Reviewed-By: Daijiro Wachi Reviewed-By: Derek Lewis ------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/38717
Reviewed-By: James M Snell Reviewed-By: Daijiro Wachi Reviewed-By: Derek Lewis --------------------------------------------------------------------------------
⚠ Commits were pushed since the last review:
⚠ - tools: added remark-frontmatter
ℹ This PR was created on Tue, 18 May 2021 06:07:57 GMT
✔ Approvals: 3
✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/38717#pullrequestreview-701554823
✔ - Daijiro Wachi (@watilde): https://github.com/nodejs/node/pull/38717#pullrequestreview-701558858
✔ - Derek Lewis (@DerekNonGeneric): https://github.com/nodejs/node/pull/38717#pullrequestreview-701575341
✖ Last GitHub CI failed
ℹ Green GitHub Actions CI is sufficient
--------------------------------------------------------------------------------
✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/1028835470

[jasnell]

Landed in 74e319f