What is MarkFoundry?

MarkFoundry is a professional document workspace for Markdown, JSON, YAML, and structured writing in your browser.

Steps

1. Open MarkFoundry at the hosted app URL.
2. Create or open files from the welcome screen.
3. Use tabs to manage multiple documents.
4. Preview Markdown and export when ready.

Notes

• MarkFoundry runs in modern browsers at https://markfoundry.app/.
• Install it as a PWA for quick access from your desktop, dock, or home screen.
• Core editing works with local browser storage and file access.

Opening the app

Access MarkFoundry from any supported browser.

Steps

1. Go to https://markfoundry.app/
2. Wait for the workspace to load.
3. Review the welcome screen and quick actions.
4. Choose New Markdown, New JSON, New YAML, Open File, or Import Document.

Notes

• Bookmark https://markfoundry.app/ for quick access.
• You can also install MarkFoundry as a PWA for an app-like experience.

Common mistakes

• Using an outdated browser that lacks modern file APIs.

Installing MarkFoundry as a PWA

Install MarkFoundry to your device so it opens like a native app from your launcher, dock, or home screen.

Steps

1. Open https://markfoundry.app/ in a supported browser.
2. In Chrome or Edge, click the install icon in the address bar and confirm installation.
3. In Safari on iPhone or iPad, tap Share, then Add to Home Screen.
4. Launch MarkFoundry from your apps menu, dock, or home screen.
5. Continue editing with the same workspace, tabs, and local file workflows.

Notes

• Installed PWAs open in their own window without browser chrome.
• Recent files and drafts remain available through browser storage on that device.
• Import and export features still require an internet connection.

Common mistakes

• Installing from a private browsing window — data may not persist between sessions.

Creating a new Markdown file

Start writing a new Markdown document.

Steps

1. Open MarkFoundry.
2. Click New Markdown.
3. Start writing in the editor.
4. Use Preview mode to see the final document.
5. Use Export when your document is ready.

Notes

• Markdown supports headings, lists, tables, code blocks, and more.
• Use split view to edit and preview simultaneously.

Common mistakes

• Forgetting to preview before exporting.

Creating a JSON file

Create and edit structured JSON data.

Steps

1. Open MarkFoundry.
2. Click New JSON.
3. Write or paste JSON content.
4. Use format actions to tidy the file.
5. Review validation errors if the JSON is invalid.

Notes

• Invalid JSON shows clear error messages in the editor.

Creating a YAML file

Create and edit YAML configuration or data files.

Steps

1. Open MarkFoundry.
2. Click New YAML.
3. Write or paste YAML content.
4. Use format actions to standardize indentation.
5. Inspect the tree view when available.

Notes

• Consistent indentation is important in YAML.

Opening a local file

Edit files stored on your device.

Steps

1. Click Open File on the welcome screen or toolbar.
2. Select a supported file from your device.
3. Edit the file in the workspace.
4. Save changes back to the file when prompted.

Notes

• Supported types include Markdown, JSON, YAML, MDX, and text files.
• Browser file access depends on your browser and permissions.

Using tabs

Manage multiple open documents efficiently.

Steps

1. Open several files or create new ones.
2. Click a tab to switch between documents.
3. Close tabs you no longer need.
4. Each tab keeps its own editor state.

Notes

• Unsaved changes remain in the tab until you save or close.

Common mistakes

• Closing a tab with unsaved work without saving first.

Editing Markdown

Write and structure Markdown content effectively.

Steps

1. Open a Markdown file.
2. Use headings to structure the document.
3. Add lists, tables, code blocks, and links as needed.
4. Use the document tools panel for outline and TOC.
5. Run lint checks when available.

Notes

• GitHub Flavored Markdown is supported.
• Frontmatter can be used at the top of documents.

Viewing live preview

See how your Markdown renders while you write.

Steps

1. Open a Markdown file.
2. Switch to Preview mode or Split view.
3. Edit source on one side and watch preview update.
4. Scroll through the preview to check formatting.

Notes

• Large documents may take a moment to render.

Using split view

Edit and preview simultaneously.

Steps

1. Open a Markdown file.
2. Enable Split view from the editor toolbar.
3. Edit on the left and preview on the right.
4. Adjust panel sizes if supported.

Notes

• Split view is ideal for long-form writing and review.

Importing documents

Convert external documents into Markdown.

Steps

1. Click Import Document from the welcome screen or menu.
2. Choose a source: DOCX, PDF, HTML, TXT, or web page URL.
3. Upload or enter the source content.
4. Review the converted Markdown.
5. Edit and save as needed.

Notes

• Conversion quality varies by source format.
• Complex PDF layouts may require manual cleanup.

Exporting to PDF

Create a shareable PDF from Markdown content.

Steps

1. Open a Markdown file.
2. Review the preview.
3. Click Export.
4. Choose PDF.
5. Select page size and export theme if available.
6. Click Export PDF.
7. Save the file to your device.

Notes

• Tables, headings, links, and code blocks should remain structured.
• Large files may take longer.
• PDF export depends on the conversion service.

Common mistakes

• Exporting before reviewing the preview for formatting issues.

Exporting to DOCX

Generate a Word-compatible document from Markdown.

Steps

1. Open a Markdown file.
2. Review the preview.
3. Click Export.
4. Choose DOCX.
5. Select export options if available.
6. Save the DOCX file to your device.

Notes

• DOCX export uses the conversion service powered by Pandoc.

Working with JSON

Edit, validate, and format JSON files.

Steps

1. Open or create a JSON file.
2. Edit content in the Monaco editor.
3. Use format actions to prettify JSON.
4. Fix validation errors shown in the editor.
5. Inspect tree view when available.

Notes

• JSON must be valid before export or conversion.

Working with YAML

Edit, validate, and format YAML files.

Steps

1. Open or create a YAML file.
2. Maintain consistent indentation.
3. Use format actions to standardize spacing.
4. Review validation feedback.
5. Convert to JSON when needed.

Notes

• Tabs vs spaces can cause YAML parsing issues.

Browser cache and recovery

Recover unsaved work after refresh or crash.

Steps

1. Continue working — MarkFoundry caches drafts in browser storage.
2. If the browser closes unexpectedly, reopen MarkFoundry.
3. Check recent files and recovery prompts.
4. Restore drafts when offered.
5. Save important work to local files regularly.

Notes

• Browser cache is not a substitute for saving to disk.
• Clearing browser data may remove cached drafts.

Saving files

Persist your work to local storage or downloaded files.

Steps

1. Edit your document.
2. Use Save or Save As from the file menu or toolbar.
3. For opened local files, save back to the original location.
4. For new files, choose a download location.

Notes

• Save frequently for important documents.

Common mistakes

• Relying only on browser cache for long-term storage.

Managing recent files

Quickly reopen recently edited documents.

Steps

1. Open MarkFoundry.
2. View the Recent section on the welcome screen.
3. Click a recent file to reopen it.
4. Remove items from recent list if supported.

Notes

• Recent files are stored in browser local storage.

Using templates

Start documents faster with pre-built structures.

Steps

1. Open the Templates section when available.
2. Choose a template for reports, proposals, or documentation.
3. Create a new file from the template.
4. Customize content for your needs.

Notes

• Templates are planned for Pro and Team plans.

Common errors

Understand frequent issues and how to resolve them.

Steps

1. JSON/YAML validation errors: fix syntax and indentation.
2. Export failures: check conversion service availability.
3. Import issues: try a simpler source format or clean up manually.
4. File access denied: grant browser file permissions.

Notes

• Check the status bar for contextual error messages.

Troubleshooting

Resolve workspace and performance issues.

Steps

1. Refresh the page if the editor becomes unresponsive.
2. Clear workspace cache if storage is full.
3. Try a different browser if file APIs fail.
4. Check your internet connection for import/export features.
5. Contact support for persistent issues.

Notes

• Export and import features require network access.

Privacy and local storage

Understand how MarkFoundry handles your data.

Steps

1. Core editing uses browser local storage and selected files.
2. Conversions may pass through a secure conversion service temporarily.
3. Files are not stored permanently by default.
4. Review the Privacy Policy for full details.

Notes

• You control what files you open and save locally.

Best practices

Get the most from MarkFoundry workflows.

Steps

1. Save important documents to local files regularly.
2. Install MarkFoundry as a PWA if you use it daily.
3. Use preview before exporting to PDF or DOCX.
4. Keep JSON and YAML formatted and validated.
5. Use headings and outlines for long Markdown documents.
6. Back up workspace cache before clearing browser data.

Notes

• Split view helps catch formatting issues early.
• Templates speed up repetitive document types.