Giter Club home page Giter Club logo

documorph's Introduction

documorph

documorph is a .NET package and command-line tool for converting between document file formats. The initial implementation supports only .docx to .md files, but other formats will be considered for the future.

documorph example

Package

dotnet package install lpains.documorph --prerelease

Getting Started

// Create an instance of the DocxToMarkdownProcessor class. This class requires the .docx file path.
var processor = new DocxToMarkdownProcessor(source.FullName);

// Invoke the Process() method which returns the markdown content and media files.
var (markdown, media) = processor.Process();

CLI

dotnet tool install --global lpains.documorph.cli --prerelease

Getting Started

Upon installation, access the tool by executing documorph in your terminal. For specific command details, refer to the sections below or utilize the CLI help via documorph -h.

documorph md --in <input> --out <output> [-?, -h, --help]

Basic usage example:

documorph --in .\source.docx `
           --out .\target.md

Output file (target.md):

# Heading 1

1. numbered lists are supported

## Heading 2

- bullet lists too

### Heading 3

> You can create quotes and tables

| Column 1 | Column 2 |
|----------|----------|
| value 1  | value 2  |

#### Heading 4
You can also add links like this: [Link](https://www.example.com)

And images like this:
![Image](image1.png)

And **bold** or *italic* or __underscore__ or ~~striked~~ text.

Parameters

--in (required)

The input .docx file or directory. If a folder is provided, all the .docx files will be converted. Any .docx file should be a valid Open XML Word document.

--out (required)

The output file or directory full path. The media files will be dropped in the folder where the output files are in.

documorph's People

Contributors

jlucaspains avatar dependabot[bot] avatar

Stargazers

 avatar John M. Baughman avatar

Watchers

 avatar

documorph's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.