https://github.com/aexol-studio/mdtx

📄 MDTX - Markdown CMS Overlord . Easily managable markdown cms
https://github.com/aexol-studio/mdtx

cms markdown

Last synced: 2 months ago
JSON representation

📄 MDTX - Markdown CMS Overlord . Easily managable markdown cms

• Host: GitHub
• URL: https://github.com/aexol-studio/mdtx
• Owner: aexol-studio
• Created: 2022-10-13T14:51:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-24T12:07:18.000Z (almost 2 years ago)
• Last Synced: 2024-11-01T14:07:34.406Z (3 months ago)
• Topics: cms, markdown
• Language: TypeScript
• Homepage: https://dev.mdtx.cloud
• Size: 2.31 MB
• Stars: 17
• Watchers: 5
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# MDtx [![NPM Version](https://img.shields.io/npm/v/mdtx.svg?style=flat)](https://www.npmjs.com/package/mdtx) [![NPM Version](https://img.shields.io/github/checks-status/aexol-studio/mdtx/main)](https://www.npmjs.com/package/mdtx) [![NPM Version](https://img.shields.io/github/last-commit/aexol-studio/mdtx)](https://github.com/aexol-studio/mdtx)

![Alt Text](packages/mdtx-cms/public/PresentationOfMDtx.gif)

# 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)](https://img.shields.io/github/package-json/v/aexol-studio/mdtx?color=yellow&filename=%2Fpackages%2Fmdtx-cli%2Fpackage.json&label=CLI&style=for-the-badge)](https://github.com/aexol-studio/mdtx) | [![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/aexol-studio/mdtx?color=green&filename=%2Fpackages%2Fmdtx-core%2Fpackage.json&label=CORE&style=for-the-badge)](https://github.com/aexol-studio/mdtx/tree/main/packages/mdtx-core) | [![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/aexol-studio/mdtx?color=white&filename=%2Fpackages%2Fmdtx-plugin-nextjs%2Fpackage.json&label=NextJS-plugin&style=for-the-badge)](https://github.com/aexol-studio/mdtx/tree/main/packages/mdtx-plugin-nextjs)

## 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

```

#### [Readme CORE](https://github.com/aexol-studio/mdtx/tree/main/sandbox/mdtx-example/Readme.md)

#### [Readme NextJS Plugin](https://github.com/aexol-studio/mdtx/tree/main/sandbox/mdtx-nextjs-example/Readme.md)

## Roadmap

- [x] NextJS plugin

- [ ] Gatsby plugin

- [ ] Tree building

- [ ] Summary building

- [ ] Other language generation