This package turns Atom into a Markdown personal Wiki. To get the best experience you have to install pandoc, calibre-ebook and add a reference of the install location into your PATH variable. Furthermore you have to install the following packages.
The WikiLink checker, checks for broken links, within all markdown files. A broken link can be a markdown file, an anchor or image files. If the broken WikiLink is a markdown file, you can create a new file at the referenced location.
The WikiLink checker, also tries to find alternative locations, by searching the Wiki (project) for matching filenames. It lists the alternative files for each link, so you can decide, which is the correct one and easily link to it. Furthermore you can navigate to each broken WikiLink to manually change it.
Shortcut | Action |
---|---|
ctrl-alt-l | Toggle WikiLink checker |
The WikiSearch is somehow like the built-in search, but only searches in markdown files. The representation of the results is also different. The WikiSearch keeps your search results in the panel (search history), so you can keep track of the results. If you want to remove a specific search or the complete results, you can do that too. You can also abort a running search action, if it takes too long.
Shortcut | Action |
---|---|
ctrl-alt-s | Toggle WikiSearch |
The export function requires pandoc and calibre-ebook, so make sure you install the applications and add their binary pathes to your PATH variable. Before you can export markdown files to a specific target, you have to drag and drop those into the ExportSelection area. If you have selected some files, the export feature allows you to export them into predefined targets or custom exports.
Current predefined targets
If you need to set your own export commands, e.g. you use a latex preprocessor, you can add them in the custom export params section in the export panel (see demo).
Parameters
Of course you can ignore %2 and the custom extension, if your command or script handles the export.
Custom settings, refer to demo
Shortcut | Action |
---|---|
ctrl-alt-e | Toggle Export |
The table of contents feature displays a toc panel for the current markdown file, so you have an overview of the headings of your markdown file. The toc supports setext as well as atx style (refer to: markdown syntax). You can navigate to a heading entry by clicking it.
Shortcut | Action |
---|---|
ctrl-alt-shift-t | Toggle toc |
ctrl-alt-u | Switch toc to left/right |
The WikiHome is designed to specify a markdown file as WikiHome, so have an entry point to your wiki. You can manually change it in the settings of this package, with the defined shortcut or in the context menu of the atom text editor. If the file doesn't exist, it will be created.
Shortcut | Action |
---|---|
ctrl-alt-cmd-up | Go to WikiHome |
ctrl-alt-cmd-h | Set current file as WikiHome |
The WikiHome is designed to specify a markdown file as WikiHome, so you have an entry point to your wiki. You can manually change it in the settings of this package, with the defined shortcut or in the context menu of the atom text editor. If the file doesn't exist, it will be created.
Shortcut | Action |
---|---|
ctrl-alt-cmd-up | Go to WikiHome |
ctrl-alt-cmd-left | Go page back |
ctrl-alt-cmd-right | Go page forward |
The orphaned WikiPages checker, checks for WikiPages (markdown files), which are not referenced (not linked) in the whole Wiki project folder and mark them (red foreground color) in the atom tree view. Note: If the tree view gets redrawn, you have to, manually, check again. This happens if you collapse and expand a folder. If you need to check for orphaned WikiPages in a specific folder, you also have to expand that folder.
No settings available
Shortcut | Action |
---|---|
ctrl-alt-o | Check orphaned WikiPages |
The wordcount feature, counts words, characters, rows, etc. Please refer to wordcount features section for all properties.
No shortcuts available
The autosave function has no visual user interface, but you can change the behavior in the autosave settings section of this package. If the autosave function is enabled, it will automatically save all open markdown documents in the given interval.
No shortcuts available
No demo available
The drag and drop function also has no visual user interface, but you can change the behavior in the drag and drop settings section of this package. The drag and drop feature has the following behavior.
No shortcuts available
This feature toggles between three modes (requires markdown-preview-enhanced)
Feels like a Wiki in combination with WikiNavigation, WikiHome and WikiSearch, because once you've edited your wiki pages, you can
No settings available
Shortcut | Action |
---|---|
ctrl-alt-m | Toggle edit/preview |
This feature opens the WikiLink und the cursor position. It opens Markdown files within Atom and if the option (see below), is set to true, it tries to open non markdown files in the desktop's default manner.
Shortcut | Action |
---|---|
ctrl-alt-cmd-j | JumpToWikiLink |
No demo available
This feature provides autocomplete functionality for WikiLinks (see demo). It returns a suggestion list of markdown filepaths within the current project. The filepaths are relative to the currently editing file.
No settings available
No shortcuts available
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.