newjs-md

A lightweight tool to convert Markdown and JSON files into Vue Single File Components (SFC).

Installation

Install newjs-md globally:

1npm install -g newjs-md

Alternatively, you can use it locally via npx:

1npx newjs-md

Usage

Initialize a new project

1# Global usage:
2newjs-md init
3
4# Local usage:
5npx newjs-md init

Convert a single file

1# Global usage:
2newjs-md template.md
3
4# Local usage:
5npx newjs-md template.md

Watch mode

1# Global usage:
2newjs-md watch
3
4# Local usage:
5npx newjs-md watch

Get Help

1# Global usage:
2newjs-md help
3
4# Local usage:
5npx newjs-md help

File Structure

your-project/
├── templates/          # Your markdown/JSON templates
├── pages/             # Generated Vue components
└── src/
    └── components/    # Your Vue components

Template Format

Markdown

1@TitleBar
2# My Page Title
3
4Content goes here...

JSON

1{
2  "component": "PageLayout",
3  "content": "My page content"
4}

Configuration

Create newjsTemplate.config.json in your project root:

1{
2  "templatesDir": "./templates",
3  "pagesDir": "./pages",
4  "componentPaths": ["./src/components"]
5}

Integration with Vite

To integrate with Vite, update your package.json scripts. For example, using npm-run-all:

1{
2  "scripts": {
3    "dev": "run-p dev:vite dev:watch",
4    "dev:vite": "vite",
5    "dev:watch": "newjs-md watch",
6    "build": "vite build",
7    "preview": "vite preview"
8  }
9}

This configuration will run both Vite’s dev server and newjs-md’s watch mode concurrently.

License

MIT