Giter Club home page Giter Club logo

prismdoc's Introduction

RubyApi

Notes

Model

Entry

  • has_many :documents
  • belongs_to :entry_type
  • string :name
  • string :fullname

EntryType

  • has_many :entries
  • string :name ** eg. "class" "module" "class_method" "instance_method" "constant" "special_gvar"

Document

  • belongs_to :entry
  • belongs_to :language
  • text :body

Language

  • has_many :documents
  • string :english_name
  • string :native_name

xxxx

xxxx is a ...

Features

Demo

[http://blazing-ice-2849.herokuapp.com/en/]http://blazing-ice-2849.herokuapp.com/en/ English documentation

[http://blazing-ice-2849.herokuapp.com/ja/]http://blazing-ice-2849.herokuapp.com/ja/ Japanese documentation

[http://blazing-ice-2849.herokuapp.com/eo/]http://blazing-ice-2849.herokuapp.com/eo/ Esperant documentation (demo for translation)

Development

  1. git clone

  2. bundle

  3. cp config/database.yml.sample config/database.yml

  4. rake db:migrate

  5. rake docsource:rdoc:download

  6. rake docsource:rdoc:core

  7. rake import:entries VER=1.9.3

  8. rake import:documents VER=1.9.3 LANG=en

License

MIT

Contact

https://github.com/yhara/prismdoc

Yutaka HARA (yhara)

twitter: @yhara_en

prismdoc's People

Stargazers

Angus H. avatar y-yagi avatar  avatar Yoshi Oikawa avatar Masaki Matsushita avatar Sho Hashimoto avatar  avatar okkez avatar Narihiro Nakamura avatar kyoendo avatar Yutaka HARA avatar Akira Matsuda avatar TAKAGI Masahiro avatar Kenichi Takahashi avatar

Watchers

Yutaka HARA avatar Nihad Abbasov avatar  avatar

Forkers

rurema

prismdoc's Issues

Define licence of translated text

Translated text may be used in various formats (PDF, epub, etc). We should ask user to agree that the translation is treated under some licence (Ruby's, CC or something)

User authentication

Or at least add some confirmation like "Your translation will be treated under xxx licence" to input forms.

Entry must have field "version_id"

  • ClassEntry has field "superclass_id"
  • Some classes have different superclass in Ruby 1.8/1.9 (eg. Object.superclass is nil in 1.8 and BasicObject in 1.9)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.