Procesador de Archivos Markdown de Aspose.Words para .NET

El Aspose.Words Markdown File Processor para .NET permite a los desarrolladores crear, cargar, editar y guardar documentos de marcado de forma programática utilizando el mismo modelo de objetos conocido como ASPOSE. Words. Está diseñado para la generación de contenido dinámica, la automatización de la documentación y los flujos de trabajo de transformación donde el marcador es el formato preferido.

Instalación y configuración

  • Instalar el paquete NuGet Aspose.Words.
  • Aplicar su licencia ( Licenciamiento Medido ).).
  • Añadir el Aspose.Words Nombre para tu proyecto.
  • Para los objetivos de marco y la configuración del paquete, vea el Guía de instalación .

Platformas apoyadas: Windows, Linux, macOS, OS móvil con .NET Framework, .NET Core/5/6+, o Mono.IDEs: Visual Studio 2010–2022, Xamarin, MonoDevelop.

Inicio rápido: Crea un archivo de marcado 

var doc = new Document();
var builder = new DocumentBuilder(doc);

// Insert a horizontal rule (renders as '-----' in Markdown)
builder.InsertHorizontalRule();

doc.Save("Output.md");

Características y Funcionalidad

Creación de documentos

  • Generar nuevo .md Los archivos son dinámicos.
  • Insertar títulos, parágrafos, listas, tablas y metadatos.
  • Configure propiedades de nivel de documento como título, autor y etiquetas.

Carga de documentos

  • Carga existente .md archivos de discos, corrientes o líneas.
  • Conserva la estructura: títulos, tablas, listas y formatación en línea.
  • Mantenes bloqueos de código, metadatos y enlaces de estilo de referencia.

DOM (Modelo de Objetos de Documento)

  • Acceso y manipulación:

  • Parágrafos y carreras (boldo, italiano, estricto, código en línea)

  • Capítulos (H1 a H6)

  • Listas (ordenado / no ordenado, nido)

  • Tablas, rayas y células

  • CodeBlock y InlineCod

  • Links & Images (con alt texto, títulos y URLs)

Título y formatación en línea

  • Aplique la sintaxe Markdown a través de los atributos de ejecución.
  • Acerca de la valentía (**), El italiano (*), y de manera estricta (~~), y el código en línea (```).).
  • Mantiene el formato a través de los párrafos y las listas de manera fiable.

Cabezas y Secciones

  • Adaptación programática de los niveles de dirección.
  • Reorganizar secciones para la generación TOC.
  • Se dividen o se fusionan bloques basados en el título.

Listas y listas Nested

  • En el caso de que se ordenan (1., 2.) o en el caso de que se trate de (-, *) Las listas.
  • Convertir los parágrafos en artículos de lista.
  • Insertar, eliminar o transformar tipos de lista de forma dinámica.

Mesa

  • Crea y manipula las tablas de marcado de GitHub.
  • Insertar líneas/columnas, fusionar células y editar contenido.
  • Suporte de células multilíneas con formato conservado.

Imágenes y enlaces

  • Añadir o actualizar las referencias de imagen (![alt](url "title")).).
  • Enlaces a los hipervínculos ([text](url "title")).).
  • Apoya la sintaxe de enlace en línea y en estilo de referencia.

Bloques de código

  • Insertar bloques de código con etiquetas de lenguaje (‘csharp).
  • Gestión de espanas de código inline con escape automático.
  • Conexión de estilos de cuchillo (backticks o tildes).

Metadatos y Front-Matter

  • Leer/Escribir YAML o TOML front-matter.
  • Mantener metadatos para los generadores de sitios estáticos (Hugo, Jekyll, etc.).

Ahorro y exportación

  • Salva de vuelta a .md Con las opciones:

  • Conserva el espacio y los comentarios.

  • Normalizar la indentación y los terminales de línea.

  • Estripa o actualiza los metadatos con callbacks.

Exemplos avanzados

Redacción de Markdown existente 

var doc = new Document("Quotes.md");
var builder = new DocumentBuilder(doc);

builder.MoveToDocumentEnd();
builder.ParagraphFormat.ClearFormatting();
builder.Writeln("\n");

// Insert inline code with backticks
var inlineCodeStyle = doc.Styles.Add(StyleType.Character, "InlineCode.3");
builder.Font.Style = inlineCodeStyle;
builder.Writeln("Produced by Aspose.Words Markdown Processor.");

doc.Save("UpdatedQuotes.md");

Insertar el bloque de código 

var builder = new DocumentBuilder(new Document());
builder.Writeln("```csharp");
builder.Writeln("Console.WriteLine(\"Hello Markdown\");");
builder.Writeln("```");

Mejores Prácticas

  • Utilice APIs DOM en lugar de regex para transformaciones.
  • Centralizar los metadatos en el front-matter para la compatibilidad del generador.
  • Reutilizar los objetos de documento para las actualizaciones de batch.
  • Modificaciones de cadena para minimizar el uso de la memoria.
  • APIs pre-calentados en los entornos del servidor para reducir la latencia de primera llamada.
  • Seguir el uso de la licencia en los tubos CI/CD.

Casos de uso comunes

  • Automatización de la generación README.
  • Construcción ** artículos de base de conocimiento** dinámicamente.
  • Convertir datos estructurados en Docs de Markdown.
  • El mantenimiento de gran documentación se establece de manera programática.
  • Preparación de Markdown para generadores de sitio estático.

FAQ

**Qué características de Markdown se apoyan?**Títulos, listas, tablas, imágenes, enlaces, formatación en línea, bloques de código y front-matter.

**Puedo convertir Markdown en otros formatos?**Siguiente: Load .md y guardar en DOCX, PDF, o HTML utilizando Aspose.Words.

**Se conserva el front-matter?**Sí sí. YAML y las secciones front-matter de TOML se leen/escriben.

**Suporta enlaces de estilo de referencia?**Sí. Tanto los enlaces en línea como en el estilo de referencia están apoyados.

**Es el thread-safe?**Sí, siempre que cada thread utilice su propia instancia Document.

 Español