MarkItDown documentation

[aborruso]

trafficstars

Hi, is there some MarkItDown documentation?

Thank you

[15MariamS]

The ReadMe is pretty great now! https://github.com/microsoft/markitdown?tab=readme

[aborruso]

In example I know there is a cli, but there is no info about it.

I know that it can export markdown from a YouTube URL.

And so on

Thank you

---

Scusami per la brevità, ti sto scrivendo dal cellulare.

website: https://medium.com/tantotanto 38° 7' 48" N, 13° 21' 9" E EPSG:4326

Il lun 16 dic 2024, 23:53 Mariam @.***> ha scritto:

The ReadMe is pretty great now! https://github.com/microsoft/markitdown?tab=readme

— Reply to this email directly, view it on GitHub https://github.com/microsoft/markitdown/issues/54#issuecomment-2547041047, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAHPD3DKIATR4ZKE7POFU32F5KVXAVCNFSM6AAAAABTVTAU2GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNBXGA2DCMBUG4 . You are receiving this because you authored the thread.Message ID: @.***>

[gagb]

There cli usage in readme now

[aborruso]

There cli usage in readme now

I still don't see in the readme about using it via cli and the options for using it. Do you still need to update it?

Thank you

[gagb]

Maybe we should create and host docs? The readme is getting way too long...

[lalithaar]

Maybe we should create and host docs? The readme is getting way too long...

I would love to work on setting up the docs, please let me know the support you need on my end.

[gagb]

@jackgerrits do you have suggestions?

[lalithaar]

@gagb @jackgerrits

Please share your feedback on the proposed /docs folder structure. I plan to work on creating the documentation over the next week and submit a pull request after the New Year.

I will break down the existing README into smaller chunks, ensuring that the main README.md is simple to skim through, while redirecting users to the detailed docs as needed.

Wishing you and the team a Merry Christmas to those who are celebrating! :]

docs/
├── User Guide/              # For end users
│   ├── README.md            # Overview and quick start guide
│   ├── Installation.md      # Steps to install the tool
│   ├── Configuration.md     # Configuring the tool based on use case
│   ├── Usage.md             # Detailed usage instructions
│   ├── FAQ.md               # FAQ, Support and glossary
│
├── Contributor Guide/       # For developers and contributors
│   ├── Contributing.md      # How to contribute to the project
│   ├── Code_of_conduct.md   # Community behavior guidelines
│   ├── SECURITY.md          # Reporting security vulnerabilities
│   ├── LICENSE.md           # Licensing details
│   ├── Changelog.md         # History of changes and updates

[l-lumin]

You can easily set up a host for docs using GitHub Pages. Sphinx and MkDocs are perhaps the most popular options

Example

• AWS Copilot

[gagb]

Sounds good, let's discuss this with @afourney in new years when everyone is back! :)

[HackyRoot]

Hey @gagb! Hope you enjoyed your holidays! Is there any update on documentation initiative?