# inhalt > Content management system Latest version **0.0.1-SNAPSHOT** (published 2022-02-20) · 0 weekly downloads ## Install ```sh npm install inhalt pnpm add inhalt yarn add inhalt bun add inhalt ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities. Warnings: low downloads; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.1-SNAPSHOT | | Published | 2022-02-20 | | First published | 2022-02-20 | | Weekly downloads | 0 | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=10 | | Dependencies | 8 | | Unpacked size | 86.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | lucperkins | | Keywords | cms, content, static-site, jamstack | ## Links - npm: https://www.npmjs.com/package/inhalt - Repository: https://github.com/lucperkins/inhalt - Homepage: https://github.com/lucperkins/inhalt#readme - Issues: https://github.com/lucperkins/inhalt/issues - npm.io page: https://npm.io/package/inhalt ## Dependencies (8) - [unified](https://npm.io/package/unified.md) ^10.1.1 - [fast-glob](https://npm.io/package/fast-glob.md) ^3.2.11 - [gray-matter](https://npm.io/package/gray-matter.md) ^4.0.3 - [remark-parse](https://npm.io/package/remark-parse.md) ^10.0.1 - [remark-rehype](https://npm.io/package/remark-rehype.md) ^10.1.0 - [rehype-sanitize](https://npm.io/package/rehype-sanitize.md) ^5.0.1 - [rehype-stringify](https://npm.io/package/rehype-stringify.md) ^9.0.3 - [remark-stringify](https://npm.io/package/remark-stringify.md) ^10.0.2 ## Alternatives - [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads - [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads - [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads - [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads - [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads ## Recent versions - 0.0.1-SNAPSHOT (latest) — 2022-02-20 ## README # Inhalt [![build-test](https://github.com/lucperkins/inhalt/actions/workflows/all.yml/badge.svg)](https://github.com/lucperkins/inhalt/actions/workflows/all.yml) [Coverage](https://lucperkins.github.io/inhalt/coverage) Inhalt is a TypeScript/JavaScript library for local content management. It's mean to be used with static generators and other tools that involve turning assets in your local directories—Markdown, JSON, YAML, and others—into HTML, tables of content, search indices, and all the other things that make blogs, documentation hubs, and other complex sites work. ## Status Inhalt is in its _very_ early phases—as in, still basically a weekend project. Don't use it just yet but if you have requests for what you'd want to see in a library like this, please do feel free to file an issue! ## Goals Static site generation has recently gotten _very_ interesting in the JavaScript space with the rise of blazing-fast build tools like [Vite] and [swc] and powerful, developer-friendly frameworks like [Docusaurus], [Next.js][next], [Gatsby], [Nuxt], [Astro], and [Remix]. One thing these frameworks have in common is that they require you to do your own content management. If you want to build a blog or a documentation site, you need to supply your own logic to fetch files, choose the right data from those files, convert files in formats like [Markdown] to HTML, and so on. Some of these frameworks do have good content management libraries, such as [`nuxt-content`][nuxt-content] for [Nuxt], but I look out into this space and see a lot of redundant effort. What if we could just have _one_ really good library that developers could use directly inside of these frameworks _or_ as the basis for framwork-specific libraries? Some more specific things I want to enable you to do far more easily than you can now: - Generate search indices for services like [Algolia] and libraries like [Lunr.js][lunr]. - Create and query taxonomies like tags and categories. - Generate per-page tables of content as structured data that you can style on your own. - Divide your content up into structures like sections (à la [Hugo]). - Pipe your Markdown files through highly configurable parsing pipelines (but with well-chosen defaults). - Use multiple markup formats in the same project (so not just [Markdown]). ## Example Here's an example for a [Next.js][next] project: ```tsx import { document, files } from "inhalt"; // pages/docs/index.js export async function getStaticProps() { // Fetch all Markdown files in the supplied glob // (not parsed, just the raw files) const docs = await files("docs/**/*.{md,mdx}"); return { props: { docs } } } // The rendered docs TOC export default Docs(props) { return ( <>

Docs landing page

); } // pages/docs/[slug].js export async function getStaticProps(ctx) { const { slug } = ctx.params; // Fetch a single doc (already converted to HTML) const doc = document(slug); return { props: { doc } } } export async function getStaticPaths() { // Fetch all Markdown files in the supplied glob // (not parsed, just the raw files) const docs = await files("docs/**/*.{md,mdx}"); return docs.map(doc => { params: { slug: doc.slug } }) } export default Doc(props) { const doc = props.doc; return (
); } ``` ## Documentation Docs are very much a work in progress but you can check out the [Typedoc][docs]. [algolia]: https://algolia.com [astro]: https://astro.build [docs]: https://lucperkins.github.io/inhalt [docusaurus]: https://docusaurus.io [gatsby]: https://gatsbyjs.com [hugo]: https://gohugo.io/content-management/sections [lunr]: https://lunrjs.com [markdown]: https://www.markdownguide.org [next]: https://nextjs.org [nuxt]: https://nuxtjs.org [nuxt-content]: https://content.nuxtjs.org [remix]: https://remix.run [swc]: https://swc.rs [vite]: https://vitejs.dev --- _Source: https://npm.io/package/inhalt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._