Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krasnoukhov/octodmin
Content management for Jekyll blogs
https://github.com/krasnoukhov/octodmin
Last synced: 6 days ago
JSON representation
Content management for Jekyll blogs
- Host: GitHub
- URL: https://github.com/krasnoukhov/octodmin
- Owner: krasnoukhov
- License: mit
- Created: 2015-01-27T16:44:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-03-27T20:52:46.000Z (over 9 years ago)
- Last Synced: 2024-12-10T05:32:40.109Z (15 days ago)
- Language: Ruby
- Homepage:
- Size: 1.78 MB
- Stars: 86
- Watchers: 8
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Octodmin
Content management for Jekyll blogs
[](http://badge.fury.io/rb/octodmin)
[](http://travis-ci.org/krasnoukhov/octodmin?branch=master)
[](https://coveralls.io/r/krasnoukhov/octodmin?branch=master)
[](https://codeclimate.com/github/krasnoukhov/octodmin)
[](https://gemnasium.com/krasnoukhov/octodmin)
## Installation
Add this line to your Jekyll project's Gemfile:
```ruby
gem 'octodmin'
```
And then execute:
```bash
$ bundle
```
## Usage
Octodmin assumes that there is a `_config.yml` with Jekyll
configuration.
Add `config.ru` to your project:
```ruby
require "octodmin/app"
run Octodmin::App.new(__dir__)
```
Run it as a Rack application:
```bash
$ rackup
```
## Configuration
Octodmin can be configured using `_config.yml`. For example:
```yaml
# Octodmin settings
octodmin:
transliterate: ukrainian
deploys:
- config_file: _deploy.yml
front_matter:
custom:
type: "text"
```
Valid options:
`transliterate`: use any of [babosa](https://github.com/norman/babosa#locale-sensitive-transliteration-with-support-for-many-languages)'s
languages for slug transliteration. Default is `latin`
`deploys`: if you use `octopress-deploy`, specify your deploy configuration
file to get a "Deploy" button in Octodmin.
`front_matter`: if you use custom front matter attributes, specify all
of them to extend the edit form with corresponding inputs.
Please note that Octodmin uses Octopress internally, so make sure you configure it
accordingly. For example:
```yaml
# Octopress
post_ext: markdown
post_layout: post
```
## Deployment
Since Octodmin is a simple Rack app, use your favorite Ruby application server.
For example, add `puma` to Gemfile, run `bundle`, and then `rackup`.
That's it.
When deploying Octodmin to a remote server, make sure you're able to run
`git pull`, `git push` and `octopress deploy` (if needed) successfully
in the shell of your remote user.
For basic HTTP authentication, use `Rack::Auth::Basic`.
Example for your `config.ru`:
```ruby
use Rack::Auth::Basic, "Octodmin" do |username, password|
[username, password] == [ENV["USERNAME"], ENV["PASSWORD"]]
end
```
Just set ENV variables and you're good to go.
## Development and testing
You would need `npm` and `bower`. Run `bower install` to install asset
dependencies.
Run `rackup` to start the development server.
Run `rspec` to run tests.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## LICENSE
The MIT License