Aero Markdown reads the files you already have. Open one Markdown document for an isolated read, or open its folder when you want the surrounding documentation in the file tree. The files remain at their original paths.
Try a connected folder
Download the sample Markdown folder and unzip it. It contains six plain Markdown files: an overview, specification, architecture, plan, decisions and release notes; there is no installer or hook in the download.
Open one file
- In Aero Markdown, choose File → Open File…, or press Command-O.
- Select a
.md,.markdown, or.mdownfile. - Read the page and use its heading outline to find a section.
You can also drop a Markdown file onto the window. A single-file view is useful when you only need the document in front of you. Open the containing folder when you also want to browse related files.
Open the folder around the document
Choose File → Open Folder…, or press Command-Shift-O, and select the sample folder. You can also drop a folder onto the window.
Choose README.md in the file tree. The rendered page appears in the middle and its headings appear in the outline. Select Specification in the README, then follow its Architecture link and the local-file decision. Each step adds context to the original requirement.
Opening a folder does not import it into a separate library or copy it to a hosted service.
Add another folder
Use File → Add Folder… to add a second folder to the same sidebar. This lets you keep more than one local documentation folder within reach.
The folder structure remains the structure on disk. Adding a folder to the sidebar is different from moving files into a new directory.
Decide what appears in the file tree
Folder options let you include hidden files and ignore .git, node_modules, and .build. Use those options to keep the sidebar focused on the files you want to read. They control the folder scan; they do not delete those directories.
Recent items let you return to files or folders you have opened before. The first welcome also includes a sample project if you want to explore before opening your own documentation.
What opening a file changes
Opening and rendering do not rewrite the source. If you edit the open document and choose Save, that writes the file. Automatic reload can follow changes made by another tool, subject to unsaved-edit protection.
Read how local files work, how to follow links, or how to set the reading page.