https://github.com/emilebosch/veda
Veda is a simple git based documentation viewer. It allows you to mount documentation fast and easy in your app.
https://github.com/emilebosch/veda
documentation rails ruby sinatra veda
Last synced: 2 months ago
JSON representation
Veda is a simple git based documentation viewer. It allows you to mount documentation fast and easy in your app.
- Host: GitHub
- URL: https://github.com/emilebosch/veda
- Owner: emilebosch
- Created: 2013-10-01T09:36:41.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2023-01-25T03:25:15.000Z (over 3 years ago)
- Last Synced: 2025-06-07T14:43:21.355Z (about 1 year ago)
- Topics: documentation, rails, ruby, sinatra, veda
- Language: Ruby
- Homepage: http://emile.wtf
- Size: 79.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Veda
Collaborate documentation and WIKI
## What is Veda?
Veda is Git based documentation system, it aims to simplify writing documentation and text using
the same methodologies as writing code. Everyone can fork and contribute documentation.
## Getting Veda
Veda is still in prerelease. But you can get a sneak peek by running:
```bash
gem install veda --pre
```
In case you use RBENV type `rbenv rehash` to make the `veda` command available.
Then go in to a directory with markdown and type:
```bash
veda
```
to start the veda server. You can then browse to `http://localhost:4567` to read the
documentation.
## Pow veda
You can also add it easy to pow with:
```bash
veda pow
```
## Installing Veda documentation
Veda makes it easy to download and view documentation written on github.
```bash
veda install emilebosch/guides
```
It will clone the repo from github, install it in `~/.veda/library/emilebosch/guides`.
To view a list of locally installed documentation type:
```bash
veda list
```
## Mounting Veda in Rails apps
You can mount Veda also in your rails app like any other rack app. This allows you
to expose your documentation fast and easy. Just put this baby in your `routes.rb`
```ruby
mount Veda::Server.new(Rails.root.join("./docs"), Rails.root) => "/docs"
```
## Extending Veda
You can extend veda by placing a `Vedafile` in a directory. This will be loaded runtime.
You can then freedompatch Veda into awesomeness.
### Providing your own views
For instance, u can provide your own views, u can just patch the `Veda::Server`.
```ruby
class Veda::Server
set :root, File.dirname(__FILE__)
end
```
## Hacking on Veda
Yes, please help out and make Veda awesome! I need your mad skills to take this further.
Now, because Veda, relies on git, there is a git repo in a git repo. (GITCEPTION! OMG!) Anyway,
since, i haven't found an elegant way to do this yet (Please PR one!) You need
to run `rake unzip` to unzip the test repo.
So in short, to test:
```bash
bundle rake unzip
bundle rake
```
To run locally:
```bash
bundle exec veda
```