https://github.com/yusukebe/Yomico

Yet Another Markdown Viewer
https://github.com/yusukebe/Yomico

Last synced: 3 months ago
JSON representation

Yet Another Markdown Viewer

• Host: GitHub
• URL: https://github.com/yusukebe/Yomico
• Owner: yusukebe
• Created: 2012-02-06T11:20:15.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2013-09-01T19:01:54.000Z (about 11 years ago)
• Last Synced: 2024-05-28T05:47:01.912Z (6 months ago)
• Language: CSS
• Homepage: http://yusukebe.com/
• Size: 102 KB
• Stars: 25
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.mkdn
  • Changelog: Changes

Awesome Lists containing this project

README

        
# Yomico - もう一つのMarkdownビューアー

**Yomico（よみこ）はPerl製のMarkdownビューアー**です。

手元にあるMarkdownファイルを素早くプレビューするために作られました。

このREADMEファイルもMarkdownで記述されていますが、

Yomicoでプレビューしつつ書いています。

## インストール

YomicoはPerlモジュールとスクリプトで成り立っています。

また、[github上で公開](https://github.com/yusukebe/Yomico)をしています。

インストールには以下のコマンドを参考にしてください。

    $ git clone git://github.com/yusukebe/Yomico.git

    $ cd Yomico

    $ cpanm .

## 使い方

インストールが終わると「yomico」コマンドがシステム内で使えるようになります。

yomicoコマンドでMarkdownファイル、もしくはディレクトリを指定すると起動します。

    $ yomico README.mkdn

お使いのブラウザで

> http://localhost:5000

にアクセスしてください。Markdownが整形されて見られているはずです。

### 起動オプション

ポートを変更するには「-p」オプションで指定してください。

    $ yomico -p 8080 README.mkdn

## TODO

- ディレクトリ対応

- ディレクトリ一覧でアイコンとか使う

- カスタムCSS対応

- google-prettyprintなどシンタックスハイライト対応

## ネーミングについて

Yomico（よみこ）というネーミングはアニメ・小説・コミックで展開している

「**R.O.D -READ OR DIE-**」に登場する *読子・リードマン* に由来しています。

読子はビブリオマニアと言われる大の読書好きです。

彼女にMarkdownのテキストを快適に読んでもらえる事を目指して開発しています。

## ライセンス

This library is free software;

you can redistribute it and/or modify it under the same terms as Perl itself.

## 作者

Yusuke Wada ( @yusukebe )

- Blog: [ゆーすけべー日記](http://yusukebe.com/)

- Mail: 

- Twitter: [@yusukebe](http://twitter.com/yusukebe)

---

*Yomico - Yet Another Markdown Viewer*