Skip to content
HTMLSuite
Menu

Markdown Reader & Viewer

Open a Markdown file and read it as a clean, well-formatted document.

Example: deployment-guide.md168 words1 min read7 headings

Deployment Guide

This guide explains how to deploy the Orders service to production. Read it once from top to bottom before your first release.

Before you start

You need:

  1. Access to the orders-prod project
  2. The deployment CLI, version 3.2 or newer
  3. A reviewed and merged pull request

Tip: run deploy doctor to check all of these at once.

Configuration

The service reads its settings from environment variables:

Variable Required Example
DATABASE_URL Yes postgres://db:5432/orders
QUEUE_URL Yes amqp://queue:5672
LOG_LEVEL No info

Secrets

Never commit secrets. Store them in the secret manager and reference them by name:

env:
  - name: DATABASE_URL
    valueFrom: orders/database-url

Deploying

// deploy.config.js
export default {
  service: "orders",
  regions: ["eu-west-1", "us-east-1"],
  healthCheck: "/healthz",
};

Run deploy release --canary to send 5 % of traffic to the new version first.

Rolling back

If error rates rise, roll back immediately:

deploy rollback orders --to previous

Checklist

  • Migrations applied
  • Canary healthy for 15 minutes
  • Announce the release in #releases

Questions? See the runbook or ask in #platform.

How to open and read a Markdown file

  1. Click Open .md file, drop a README.md or any other Markdown file onto the page, or choose Paste Markdown.
  2. Read it as a formatted document. Use the contents list to jump between sections.
  3. Turn on Reading mode for a narrower column and a book-like font, or click Print to print the document or save it as a PDF.

Read .md files without an editor

Markdown files are plain text, so opening one in a text editor shows every #, * and |. This viewer renders the document the way it is meant to be read: headings, lists, tables, quotes and highlighted code examples. The example is a deployment guide with sections, a configuration table, YAML and JavaScript snippets and a checklist — the kind of documentation you usually find in a repository's docs/ folder.

Features

  • Clickable table of contents built from the headings.
  • Reading mode with a comfortable line length and serif font.
  • Clean print view — only the document, without toolbars.
  • File details: name, size, word count, reading time and number of headings.
  • Copy the text or the rendered HTML.
  • Private and safe: files are read in your browser, and scripts or unsafe links inside a document are removed before it is shown.

Use cases

  • Reading documentation or a README you downloaded without opening an IDE.
  • Checking what a Markdown file will look like before you publish it.
  • Printing meeting notes or a guide written in Markdown.

Related tools

Want to change the text? Open it in the Markdown editor, which has a live preview. To get HTML source code instead, use the Markdown to HTML converter. For HTML files, the HTML viewer does the same job.

Frequently asked questions

How do I open an .md file?
Click Open .md file, drop the file onto the page, or paste its text. The file is read by your browser and shown as a formatted document; it is not uploaded.
How is the table of contents made?
From the document's headings (levels 1 to 3). Click an entry to jump to that section. On large screens the contents stay visible next to the text while you read.
Can I print a Markdown file or save it as PDF?
Yes. Print opens your browser's print dialog with just the document — no toolbars or page chrome. Choose “Save as PDF” as the printer to create a PDF.
What is the difference to the Markdown editor?
The viewer is for reading: a clean page, contents, reading mode and printing. To change the text, use the Markdown editor, which puts the source and a live preview side by side.

Related tools