Put your markdown docs online without a build step
Publish documentation from markdown files. Link between documents. Use custom domains on the Publisher plan.
The problem with docs tooling
You have markdown docs in your repo. Getting them online means picking a static site generator (Docusaurus, MkDocs, GitBook), writing config files, setting up a build pipeline, and deploying somewhere. That's a lot of work for some rendered markdown.
Sometimes you don't need sidebars, versioning, or search. You need three or four documents online with URLs you can send to people. Maybe it's an internal API guide. Maybe it's onboarding docs for a new hire. Maybe it's a spec you want to share with a client.
MDtoLink gets those files online in seconds. No config. No build. No deployment pipeline.
How it works
1. Publish individual doc files
mdtolink publish docs/getting-started.md --slug getting-started
mdtolink publish docs/api-reference.md --slug api-reference
mdtolink publish docs/deployment.md --slug deployment Each file gets its own URL. Publish as many as you need.
2. Link between documents
# Getting Started
See the [API Reference](https://mdtolink.com/@yourhandle/api-reference)
for endpoint details.
Ready to ship? Follow the [Deployment Guide](https://mdtolink.com/@yourhandle/deployment). Use standard markdown links to connect your docs. Readers click through like any other website.
3. Automate with CI/CD or the API
# Publish all docs in a directory
for f in docs/*.md; do
slug=$(basename "$f" .md)
mdtolink publish "$f" --slug "$slug"
done Run this in your CI pipeline. Every push to main keeps your published docs in sync with your repo.
Why use MDtoLink for documentation?
-
No build step
No static site generator. No config files. No
npm run build. Just publish the file. -
Each doc is its own URL
Share a single document or a whole collection. Link between them with standard markdown links.
-
Custom domains
On the Publisher plan, host your docs at
docs.yourproject.com. -
REST API for automation
Publish and update docs programmatically. Integrate with your existing CI/CD pipeline or build custom workflows.
Frequently Asked Questions
Can I link between published docs?
Can I update docs without changing URLs?
mdtolink publish again with the same slug updates the content in place. The URL stays the same, so all existing links keep working.
Can I use custom domains for documentation?
How does this compare to Docusaurus?
Get your docs online in 30 seconds
Free to start. No credit card required.