Skip to content

๐Ÿ“„ MDTX - Markdown CMS Overlord . Easily managable markdown cms

Notifications You must be signed in to change notification settings

aexol-studio/mdtx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

MDtx NPM Version NPM Version NPM Version

Alt Text

What is MDtx?

  • Just add Markdown files with gray matter and it will generate typings for them,
  • Generated typings from Markdowns can get automatically converted into html structure,
  • There is a Next JS Plugin to work faster with MDtx on NextJS,

What we serve?

GitHub package.json version (subfolder of monorepo) | GitHub package.json version (subfolder of monorepo) | GitHub package.json version (subfolder of monorepo)

Readme CLI

Installing MDtx

npm i mdtx

Initializing MDtx

mdtx init

After initializing a config file mdtx.json will appear with:

{
  "in": "./content",
  "out": "./src",
}
  • in: string - is the designated folder with content, (default: "./content")
  • out: string - is the designated folder to generate mdtx.ts file, (default: "./src")

Optionally:

  • markdownToHtml: boolean - allow mdtx to convert md content to html content. (default: false)

Watch mode (on "in" path)

mdtx

Build mode (trigger once)

mdtx -b

Roadmap

  • NextJS plugin
  • Gatsby plugin
  • Tree building
  • Summary building
  • Other language generation