/verki

Author's tool

Primary LanguageJavaScript

verki

Author's tool

Feature List

UI

  1. Cross-platform (Desktop, Mobile)
  2. Author writes in Markdown
  3. Author can preview
  4. Outline approach (not folders / pages)
  5. Manuscript
  6. Research / Notebook

Infrastructure

  1. Author saves to GitHub or BitBucket
  2. Filenames are UUID v4 to avoid collaboration clobber
  3. Directory ends in ".verkaĵo" so "sample.verkaĵo"
  4. Project Configuration: "sample.verki-project"
  5. User Customization: "sample.verki-workspace"
  6. Files in Yaml format, like Jekyll.

Outputs

  1. Compiles into ePub
  2. Compiles into Mobi
  3. Compiles into PDF (6x9)
  4. Compiles into RTF

Technical

Testing

  1. BDD via Mocha
  2. Continuous Integration

Gherkin

Example

Feature: Some terse yet descriptive text of what is desired
  In order to realize a named business value
  As an explicit system actor
  I want to gain some beneficial outcome which furthers the goal

  Scenario: Some determinable business situation
    Given some precondition
      And some other precondition
     When some action by the actor
      And some other action
      And yet another action
     Then some testable outcome is achieved
      And something else we can check happens too