New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →
Socket
Book a DemoSign in
Socket

dumbledore

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

dumbledore

knowledge base and documentation platform

latest
npmnpm
Version
1.4.1
Version published
Maintainers
1
Created
Source

Dumbledore

dumbledore is a knowledge base and documentation platform that leverages Github for storage.

Current features supported:

  • Auto-sync with Github
  • Markdown
  • Offline editing/viewing

Upcoming features:

  • Homebrew install
  • In-browser editing
  • Linking between knowledge bases
  • Simplified checkout process
  • Improved CLI

Installation

npm install -g dumbledore
`dumbledore` requires NodeJS version 6 or above (for now).

Getting Started

Once installed, you create a new project by running dumbledore create [label].

While you can label each project anything you want, be aware that labels containing spaces must be wrapped in quotation marks (ie. `dumbledore create "Test Project"`).

Running create will initialize the project configuration settings in ~/.dumbledore/config.json, spin up a server and open a browser window into the project.

Common Operations

Stopping, Starting and Restarting a Server

You can run a Dumbledore project server without much impact on your system's resources, but should you ever wish to shut down a server, simply run dumbledore stop <label>.

You can always spin up a new server by running dumbledore start <label> or restart a server with dumbledore restart <label>.

Opening a Project in the Browser

Running dumbledore open <label> will open the base directory

Opening a Project in an IDE

Running dumbledore edit <label> currently attempts to open the project in a code editor such as Atom, Sublime Text, or TextMate. In the future other editors will be supported, but until then, you can manipulate or add files in the directory at ~/.dumbledore/docs/<label>.

FAQs

Package last updated on 03 Jul 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts