dumbledore v1.4.1
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 dumbledoreGetting Started
Once installed, you create a new project by running dumbledore create [label].
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>.