@vevedh/nfz-notion-markdown-editor

NFZ Notion Markdown Editor

Version courante : 0.15.3.

Éditeur Markdown pour Nuxt 4 et Vue 3, construit avec TipTap 3. Le composant propose une édition visuelle, un mode source, une preview sécurisée et une conservation sans perte des syntaxes VitePress avancées.

Documentation publique : https://vevedh.github.io/nfz-notion-markdown-editor-layer/

La baseline actuelle garde les fences de code simples directement éditables, préserve les métadonnées VitePress avancées sans perte, synchronise le v-model parent ↔ TipTap après hydratation et stabilise Playwright sous Windows avec Microsoft Edge, GPU désactivé et captures tutoriels reproductibles.

Installation

bun add @vevedh/nfz-notion-markdown-editor

export default defineNuxtConfig({
  modules: ['@vevedh/nfz-notion-markdown-editor/module']
})

Utilisation

<script setup lang="ts">
import type { NfzEditorSavePayload } from '@vevedh/nfz-notion-markdown-editor/types'

const markdown = ref('# Bonjour')

function save(payload: NfzEditorSavePayload): void {
  console.log(payload.markdown)
}
</script>

<template>
  <NfzNotionMarkdownEditor
    v-model="markdown"
    show-save-button
    @save="save"
  />
</template>

Fonctions principales

• rail de bloc + / drag, menu contextuel monter/descendre/dupliquer/supprimer, toolbar sticky et menu / utilisable au clavier ;
• barre d’état, colonne d’écriture configurable et raccourcis Ctrl/⌘+K / Ctrl/⌘+S ;
• tableaux, listes de tâches, citations et blocs de code ;
• images, vidéos, Mermaid et édition Filerobot ;
• source Monaco et preview Shiki ;
• import DOCX/PDF ;
• export Markdown, HTML, JSON, DOCX et PDF ;
• profils module complet ou léger ;
• compatibilité source avec les extensions Markdown intégrées à VitePress.

Feature flags

Le module peut désactiver les tableaux, médias, diagrammes, Filerobot, import/export, preview et mode source. Cette configuration permet de conserver un profil léger lorsque l’application n’utilise pas les fonctions avancées.

Le scénario examples/fresh-nuxt4-module-lite-app valide ce profil dans une application Nuxt 4 minimale.

Développement

Le lockfile commité est la source de vérité. Un nettoyage normal conserve bun.lock; sa régénération est une action volontaire.

bun run install:clean
bun dev
bun run typecheck
bun run test
bun run docs:dev
bun run docs:screenshots

Pour mettre à jour volontairement les dépendances transitives et reconstruire bun.lock :

bun run lockfile:refresh

Relisez alors le diff du lockfile avant de lancer bun run certify:windows.

Documentation

La documentation publique complète est disponible ici :

https://vevedh.github.io/nfz-notion-markdown-editor-layer/

Les exemples publics sont maintenus avec les fichiers exécutables du dépôt afin de rester synchronisés avec le module.

Licence

MIT pour le code publié. L’édition complète peut utiliser le pont NFZ License Server décrit dans la documentation publique.