MDTX: Markdown transformer

Your markdown content anywhere you need it!

Log in to GitHub and find the repository you want to write some documentation or a readme for.

Everything

In one place!

Write and style your text using Markdown in our simple and intuitive interface.

MDTX

Does it all for you

Commit or make a pull request and upload it directly to the repository!

Editor presentation


# 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](https://dev.mdtx.cloud/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

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

Readme CORE

Readme NextJS Plugin

Roadmap

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

Supported by

Innovative Software Development studio © 2022