Skip to content

eneuhauser/visa

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Visa

A local node application to work with VML's internal forum, Passport. Visa enables you to use your local Markdown editor to edit Passport posts.

Installation

  1. Ensure Node.js is installed on your machine
  2. Download the application.
  3. Run npm install

Usage

  1. From the installation directory, run node visa
  2. Follow the prompts on the screen. To create a new post, leave the Post ID empty.
  3. Whenever you save your document, the post will be updated.
  4. To quite Visa, press ctrl+c

Features

  • Create new posts by leaving the post ID blank.
  • Metadata Support: the following metadata attributes are supported. Metadata must be the first line of the file and listed until the first empty line.
    • Title: Post Title
    • Affiliation: Post Group(s). Comma or line separated. Only the Group ID is required to set the group. The full name must still contain the group ID.
    • Keywords: Post tags. Comma or line separated.
    • Format: draft or complete. If set to draft, saved as not published; otherwise, published.
  • Command line options: pass the following optional items on startup (i.e. node visa -q -a Textmate)
    • q Suppresses the metadata when editing existing posts.
    • a Works like open -a AppName to specify an app rather than using default app.

Known Issues

  • Posts are sometimes saved to Passport without saving the file. This is an issue with Nodes fs.watchFile.

Future Enhancements

  • On startup, read the posts directory looking for any \d+.md files to watch
  • After retrieving one post, have the prompt ready to ask for another.
  • Update bio pages. Pass bio as the post ID to load the bio page. Files marked bio.md will be saved to user's bio page.
  • Update groups info and tools pages.

Markdown Editors

About

Use your favorite Markdown editor for VML's Passport

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published