From 11a406f399f069800ab099981a4b261594987256 Mon Sep 17 00:00:00 2001 From: Maxwell Weru Date: Wed, 6 Mar 2024 09:57:59 +0300 Subject: [PATCH] Added README.md (#21) --- .changeset/spotty-dogs-dream.md | 5 ++++ .vscode/ltex.dictionary.en-US.txt | 6 +++++ README.md | 2 +- packages/markdownlayer/README.md | 38 +++++++++++++++++++++++++++++++ 4 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 .changeset/spotty-dogs-dream.md mode change 100644 => 120000 README.md create mode 100644 packages/markdownlayer/README.md diff --git a/.changeset/spotty-dogs-dream.md b/.changeset/spotty-dogs-dream.md new file mode 100644 index 0000000..fc6b7c1 --- /dev/null +++ b/.changeset/spotty-dogs-dream.md @@ -0,0 +1,5 @@ +--- +"markdownlayer": patch +--- + +Added README.md diff --git a/.vscode/ltex.dictionary.en-US.txt b/.vscode/ltex.dictionary.en-US.txt index bdfb41f..4fb61a8 100644 --- a/.vscode/ltex.dictionary.en-US.txt +++ b/.vscode/ltex.dictionary.en-US.txt @@ -3,3 +3,9 @@ Vercel TailwindCSS NextJS markdoc +Markdoc +NextJs +markdownlayer +frontmatter +rehype +Markdownlayer diff --git a/README.md b/README.md deleted file mode 100644 index b014857..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# markdownlayer diff --git a/README.md b/README.md new file mode 120000 index 0000000..a46bd65 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +packages/markdownlayer/README.md \ No newline at end of file diff --git a/packages/markdownlayer/README.md b/packages/markdownlayer/README.md new file mode 100644 index 0000000..ee8e2bf --- /dev/null +++ b/packages/markdownlayer/README.md @@ -0,0 +1,38 @@ +# Markdownlayer [![](https://badgen.net/npm/v/markdownlayer)](https://www.npmjs.com/package/markdownlayer) + +Markdownlayer is a content SDK that validates and transforms your content into type-safe JSON data you can easily `import` into your application's pages. If you know how to or have used [Contentlayer](https://github.com/contentlayerdev/contentlayer), this is built to replace it. + +## Getting Started + +Explore the [example projects](/examples), which you can clone to try out locally. + +## Features + +- Live reload on content changes +- Fast and incremental builds +- Simple but powerful schema DSL to design your content model (validates your content and generates types) +- Auto-generated TypeScript types based on your content model (e.g. frontmatter or CMS schema) + +## Differences from Contentlayer + +- Markdoc support +- The content type is inferred from the extension hence markdown is processed correctly and not forced into MDX. +- Remark GFM, Admonitions, Reading Time, Emoji, and Slug included by default. +- Last update time and author based on Git but can be overridden via frontmatter. +- Supply configuration in `next.config.js` as an alternative to `markdownlayer.config.js`. +- Only local content (no notion sources yet). +- Only NextJs support (no Remix yet). +- No JSON/YAML content as they can be loaded directly into the JS/TS code. + +## Known issues + +- Requires ESM because the whole unified/remark/rehype ecosystem moved to ESM-only. +- Due to the ESM-only requirement, there is a webpack warning on build/dev. This will be resolved once `next.config.ts` is supported in , of if there is a new idea before then. + +### Who is using Markdownlayer? + +- [maxwellweru.com](https://maxwellweru.com)([Source](https://github.com/mburumaxwell/website)) +- [tingle.software](https://tingle.software) +- [falu.io](https://falu.io) + +Are you using Markdownlayer? You can add your page (and repo) to the end of the list via a PR. 🙏