hikidoc 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/.github/workflows/release.yaml +47 -0
- data/NEWS +6 -0
- data/NEWS.ja +6 -0
- data/README +10 -2
- data/README.ja +10 -2
- data/README.ja.md +112 -0
- data/README.md +114 -0
- data/Rakefile +10 -0
- data/TextFormattingRules.ja +2 -2
- data/TextFormattingRules.ja.md +385 -0
- data/TextFormattingRules.md +388 -0
- data/bin/hikidoc +6 -2
- data/hikidoc.gemspec +2 -1
- data/lib/hikidoc.rb +10 -10
- data/test/hikidoc_test.rb +8 -0
- metadata +23 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 5e9910cf9d5138bfcc7773f6ddca2ac40f9fe7770e52c859c14b777b0b3a870b
|
4
|
+
data.tar.gz: c85f7ae7037d469414182944a67be2a34bd61c654a27f275de53486a5c179342
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1e85debe9982628169ceff735e9dc5774425f6a4dd428ba98bc62304d1ec1918150a641f79078a4a3c69753a5c72fffc0bd0402edc4eeb192c60d525a2aee57f
|
7
|
+
data.tar.gz: d8bce427760f7003c3f9438572a571ab63c33a2eada5787f113cb61003cd272cb381db1c5f407039cba2da8026b1a5494525476a5b40e2c293924df1646d0223
|
@@ -0,0 +1,47 @@
|
|
1
|
+
name: Release
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
tags:
|
6
|
+
- "*"
|
7
|
+
|
8
|
+
jobs:
|
9
|
+
github:
|
10
|
+
name: GitHub
|
11
|
+
runs-on: ubuntu-latest
|
12
|
+
timeout-minutes: 10
|
13
|
+
steps:
|
14
|
+
- uses: actions/checkout@v5
|
15
|
+
- name: Extract release note
|
16
|
+
run: |
|
17
|
+
ruby \
|
18
|
+
-e 'print("## HikiDoc "); \
|
19
|
+
puts(ARGF.read.split(/^!! /)[1])' \
|
20
|
+
NEWS > release-note.md
|
21
|
+
- name: Upload to release
|
22
|
+
env:
|
23
|
+
GH_TOKEN: ${{ github.token }}
|
24
|
+
run: |
|
25
|
+
title=$(head -n1 release-note.md | sed -e 's/^## //')
|
26
|
+
tail -n +2 release-note.md > release-note-without-version.md
|
27
|
+
gh release create ${GITHUB_REF_NAME} \
|
28
|
+
--notes-file release-note-without-version.md \
|
29
|
+
--title "${title}"
|
30
|
+
|
31
|
+
rubygems:
|
32
|
+
name: RubyGems
|
33
|
+
runs-on: ubuntu-latest
|
34
|
+
timeout-minutes: 10
|
35
|
+
permissions:
|
36
|
+
id-token: write
|
37
|
+
environment: release
|
38
|
+
steps:
|
39
|
+
- uses: actions/checkout@v5
|
40
|
+
- uses: ruby/setup-ruby@v1
|
41
|
+
with:
|
42
|
+
ruby-version: ruby
|
43
|
+
bundler-cache: true
|
44
|
+
- uses: rubygems/configure-rubygems-credentials@v1.0.0
|
45
|
+
- name: Push gems
|
46
|
+
run: |
|
47
|
+
bundle exec rake release:rubygem_push
|
data/NEWS
CHANGED
@@ -1,5 +1,11 @@
|
|
1
1
|
! NEWS
|
2
2
|
|
3
|
+
!! 0.1.1: 2025-09-04
|
4
|
+
|
5
|
+
* Fixed license information in gem
|
6
|
+
* Fixed a WikiName escape bug (GH-10, Patch by HASHIMOTO, Naoki)
|
7
|
+
* Suppressed "literal string will be frozen" warnings (GH-12, Reported by Mamoru TASAKA)
|
8
|
+
|
3
9
|
!! Changes 0.0.6 from 0.0.5: 2010-08-28
|
4
10
|
|
5
11
|
* fix missing NEWS.ja for packaging
|
data/NEWS.ja
CHANGED
@@ -1,5 +1,11 @@
|
|
1
1
|
! NEWS.ja
|
2
2
|
|
3
|
+
!! 0.1.1: 2025-09-04
|
4
|
+
|
5
|
+
* gem�Υ饤���������
|
6
|
+
* WikiName�Υ��������פ˴ؤ������������GH-10, HASHIMOTO, Naoki���ѥå���
|
7
|
+
* "literal string will be frozen"�ٹ��������GH-12, Mamoru TASAKA��������
|
8
|
+
|
3
9
|
!! 0.0.5����0.0.6���ѹ���: 2010-08-28
|
4
10
|
|
5
11
|
* �ѥå���������NEWS.ja��ϳ��Ƥ��ޤ��Τ���
|
data/README
CHANGED
@@ -12,19 +12,27 @@ HikiDoc requires Ruby 1.8.2 or later.
|
|
12
12
|
|
13
13
|
!! Download
|
14
14
|
|
15
|
-
Get from the
|
15
|
+
Get from the GitHub repository https://github.com/hiki/hikidoc
|
16
16
|
|
17
17
|
(eg.)
|
18
|
-
|
18
|
+
git clone https://github.com/hiki/hikidoc.git
|
19
19
|
|
20
20
|
!! Installation
|
21
21
|
|
22
|
+
!!! Semi-manual installation
|
23
|
+
|
22
24
|
Run the 'setup.rb' script like so:
|
23
25
|
|
24
26
|
$ ruby setup.rb config
|
25
27
|
$ ruby setup.rb setup
|
26
28
|
# ruby setup.rb install
|
27
29
|
|
30
|
+
!!! Installation via RubyGems
|
31
|
+
|
32
|
+
Run the following command:
|
33
|
+
|
34
|
+
$ gem install hikidoc
|
35
|
+
|
28
36
|
!! Syntax
|
29
37
|
|
30
38
|
See [[TextFormattingRules]].
|
data/README.ja
CHANGED
@@ -11,20 +11,28 @@ HikiDoc
|
|
11
11
|
|
12
12
|
!! �����������
|
13
13
|
|
14
|
-
|
14
|
+
GitHub ��ݥ��ȥ� https://github.com/hiki/hikidoc �����������
|
15
15
|
����������
|
16
16
|
|
17
17
|
(��)
|
18
|
-
|
18
|
+
git clone https://github.com/hiki/hikidoc.git
|
19
19
|
|
20
20
|
!! ���ȡ���
|
21
21
|
|
22
|
+
!!! Ⱦ��ư�ǤΥ��ȡ���
|
23
|
+
|
22
24
|
�ʲ��Τ褦�� 'setup.rb' ������ץȤ��Ѥ��ƥ��ȡ��뤷�ޤ���
|
23
25
|
|
24
26
|
$ ruby setup.rb config
|
25
27
|
$ ruby setup.rb setup
|
26
28
|
# ruby setup.rb install
|
27
29
|
|
30
|
+
!!! RubyGems��ͳ�ǤΥ��ȡ���
|
31
|
+
|
32
|
+
�ʲ��Τ褦�˥��ȡ��뤷�ޤ���
|
33
|
+
|
34
|
+
$ gem install hikidoc
|
35
|
+
|
28
36
|
!! ʸˡ
|
29
37
|
|
30
38
|
[[TextFormattingRules.ja]] ��������������
|
data/README.ja.md
ADDED
@@ -0,0 +1,112 @@
|
|
1
|
+
# HikiDoc
|
2
|
+
|
3
|
+
## はじめに
|
4
|
+
|
5
|
+
'HikiDoc' は「テキスト→ HTML」変換ツールです。書きやすく読みやすい文法の
|
6
|
+
テキストをまともな HTML (や XHTML) に変換します。
|
7
|
+
|
8
|
+
## 必要なもの
|
9
|
+
|
10
|
+
HikiDoc の実行には Ruby 1.8.2 以降が必要です。
|
11
|
+
|
12
|
+
## ダウンロード
|
13
|
+
|
14
|
+
GitHub レポジトリ [https://github.com/hiki/hikidoc](https://github.com/hiki/hikidoc) から取得して
|
15
|
+
ください。
|
16
|
+
|
17
|
+
```
|
18
|
+
(例)
|
19
|
+
git clone https://github.com/hiki/hikidoc.git
|
20
|
+
```
|
21
|
+
|
22
|
+
## インストール
|
23
|
+
|
24
|
+
### 半手動でのインストール
|
25
|
+
|
26
|
+
以下のように 'setup.rb' スクリプトを用いてインストールします。
|
27
|
+
|
28
|
+
```
|
29
|
+
$ ruby setup.rb config
|
30
|
+
$ ruby setup.rb setup
|
31
|
+
# ruby setup.rb install
|
32
|
+
```
|
33
|
+
|
34
|
+
### RubyGems経由でのインストール
|
35
|
+
|
36
|
+
以下のようにインストールします。
|
37
|
+
|
38
|
+
```
|
39
|
+
$ gem install hikidoc
|
40
|
+
```
|
41
|
+
|
42
|
+
## 文法
|
43
|
+
|
44
|
+
[TextFormattingRules.ja](TextFormattingRules.ja) をご覧ください。
|
45
|
+
|
46
|
+
## メーリングリスト
|
47
|
+
|
48
|
+
参加を希望される方は、以下のようなメールを送信してください。
|
49
|
+
|
50
|
+
```
|
51
|
+
To: hikidoc@ml.fdiary.net
|
52
|
+
Cc: kazuhiko@fdiary.net
|
53
|
+
|
54
|
+
本文に自己紹介など
|
55
|
+
```
|
56
|
+
|
57
|
+
過去のメールは [http://www.fdiary.net/ml/hikidoc/](http://www.fdiary.net/ml/hikidoc/) で公開しています。
|
58
|
+
|
59
|
+
## 関連するソフトウェア
|
60
|
+
|
61
|
+
以下のソフトウェアで HikiDoc ライブラリ、または HikiDoc フォーマットが用いられています。
|
62
|
+
|
63
|
+
<dl>
|
64
|
+
<dt><a href="http://www.tdiary.org/">tDiary</a></dt>
|
65
|
+
<dd>ウェブ日記ソフトウェア</dd>
|
66
|
+
<dt><a href="http://hikiwiki.org/">Hiki</a></dt>
|
67
|
+
<dd>多機能かつ高速な Wiki クローン</dd>
|
68
|
+
<dt><a href="http://lily.sourceforge.jp/">lily</a></dt>
|
69
|
+
<dd>シンプルな CMS (Web サイト構築システム)</dd>
|
70
|
+
<dt><a href="http://search.cpan.org/perldoc?Text::HikiDoc">Text::HikiDoc</a></dt>
|
71
|
+
<dd>Perl による HikiDoc の実装</dd>
|
72
|
+
<dt><a href="http://github.com/moro/piki_doc/">PikiDoc</a></dt>
|
73
|
+
<dd>HikiDocの「プラグイン」機能を追加できるライブラリです</dd>
|
74
|
+
<dt><a href="http://sourceforge.jp/projects/mail2weblog/wiki/FrontPage">mail2weblog</a></dt>
|
75
|
+
<dd>高機能メール投稿型モブログ</dd>
|
76
|
+
</dl>
|
77
|
+
|
78
|
+
## ライセンス
|
79
|
+
|
80
|
+
Modified BSD ライセンスです。
|
81
|
+
|
82
|
+
```
|
83
|
+
Copyright (c) 2005, Kazuhiko <kazuhiko@fdiary.net>
|
84
|
+
All rights reserved.
|
85
|
+
|
86
|
+
Redistribution and use in source and binary forms, with or without
|
87
|
+
modification, are permitted provided that the following conditions are
|
88
|
+
met:
|
89
|
+
|
90
|
+
* Redistributions of source code must retain the above copyright
|
91
|
+
notice, this list of conditions and the following disclaimer.
|
92
|
+
* Redistributions in binary form must reproduce the above
|
93
|
+
copyright notice, this list of conditions and the following
|
94
|
+
disclaimer in the documentation and/or other materials provided
|
95
|
+
with the distribution.
|
96
|
+
* Neither the name of the HikiDoc nor the names of its
|
97
|
+
contributors may be used to endorse or promote products derived
|
98
|
+
from this software without specific prior written permission.
|
99
|
+
|
100
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
101
|
+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
102
|
+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
103
|
+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
104
|
+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
105
|
+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
106
|
+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
107
|
+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
108
|
+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
109
|
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
110
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
111
|
+
```
|
112
|
+
|
data/README.md
ADDED
@@ -0,0 +1,114 @@
|
|
1
|
+
# HikiDoc
|
2
|
+
|
3
|
+
## Introduction
|
4
|
+
|
5
|
+
'HikiDoc' is a text-to-HTML conversion tool for web writers. HikiDoc
|
6
|
+
allows you to write using an easy-to-read, easy-to-write plain text
|
7
|
+
format, then convert it to structurally valid HTML (or XHTML).
|
8
|
+
|
9
|
+
## Requirements
|
10
|
+
|
11
|
+
HikiDoc requires Ruby 1.8.2 or later.
|
12
|
+
|
13
|
+
## Download
|
14
|
+
|
15
|
+
Get from the GitHub repository [https://github.com/hiki/hikidoc](https://github.com/hiki/hikidoc)
|
16
|
+
|
17
|
+
```
|
18
|
+
(eg.)
|
19
|
+
git clone https://github.com/hiki/hikidoc.git
|
20
|
+
```
|
21
|
+
|
22
|
+
## Installation
|
23
|
+
|
24
|
+
### Semi-manual installation
|
25
|
+
|
26
|
+
Run the 'setup.rb' script like so:
|
27
|
+
|
28
|
+
```
|
29
|
+
$ ruby setup.rb config
|
30
|
+
$ ruby setup.rb setup
|
31
|
+
# ruby setup.rb install
|
32
|
+
```
|
33
|
+
|
34
|
+
### Installation via RubyGems
|
35
|
+
|
36
|
+
Run the following command:
|
37
|
+
|
38
|
+
```
|
39
|
+
$ gem install hikidoc
|
40
|
+
```
|
41
|
+
|
42
|
+
## Syntax
|
43
|
+
|
44
|
+
See [TextFormattingRules](TextFormattingRules).
|
45
|
+
|
46
|
+
## Mailing list
|
47
|
+
|
48
|
+
To subscribe the HikiDoc ML, please send the following mail. English
|
49
|
+
posts are also welcome.
|
50
|
+
|
51
|
+
```
|
52
|
+
To: hikidoc@ml.fdiary.net
|
53
|
+
Cc: kazuhiko@fdiary.net
|
54
|
+
Subject: subscribe <- any subject
|
55
|
+
|
56
|
+
Hello. <- any body
|
57
|
+
```
|
58
|
+
|
59
|
+
HikiDoc ML's archive is available at [http://www.fdiary.net/ml/hikidoc/](http://www.fdiary.net/ml/hikidoc/) .
|
60
|
+
|
61
|
+
## Related softwares
|
62
|
+
|
63
|
+
The following softwares use the HikiDoc library or the HikiDoc format.
|
64
|
+
|
65
|
+
<dl>
|
66
|
+
<dt><a href="http://www.tdiary.org/">tDiary</a></dt>
|
67
|
+
<dd>a Weblog/Web-diary software</dd>
|
68
|
+
<dt><a href="http://hikiwiki.org/">Hiki</a></dt>
|
69
|
+
<dd>a powerful and fast wiki clone</dd>
|
70
|
+
<dt><a href="http://lily.sourceforge.jp/">lily</a></dt>
|
71
|
+
<dd>a simple CMS</dd>
|
72
|
+
<dt><a href="http://search.cpan.org/perldoc?Text::HikiDoc">Text::HikiDoc</a></dt>
|
73
|
+
<dd>HikiDoc by Perl</dd>
|
74
|
+
<dt><a href="http://github.com/moro/piki_doc/">PikiDoc</a></dt>
|
75
|
+
<dd>a library that you can add plugin functions on HikiDoc</dd>
|
76
|
+
<dt><a href="http://sourceforge.jp/projects/mail2weblog/wiki/FrontPage">mail2weblog</a></dt>
|
77
|
+
<dd>a blog system via mobile phone email</dd>
|
78
|
+
</dl>
|
79
|
+
|
80
|
+
## License
|
81
|
+
|
82
|
+
HikiDoc's license is the 'Modified BSD License'.
|
83
|
+
|
84
|
+
```
|
85
|
+
Copyright (c) 2005, Kazuhiko <kazuhiko@fdiary.net>
|
86
|
+
All rights reserved.
|
87
|
+
|
88
|
+
Redistribution and use in source and binary forms, with or without
|
89
|
+
modification, are permitted provided that the following conditions are
|
90
|
+
met:
|
91
|
+
|
92
|
+
* Redistributions of source code must retain the above copyright
|
93
|
+
notice, this list of conditions and the following disclaimer.
|
94
|
+
* Redistributions in binary form must reproduce the above
|
95
|
+
copyright notice, this list of conditions and the following
|
96
|
+
disclaimer in the documentation and/or other materials provided
|
97
|
+
with the distribution.
|
98
|
+
* Neither the name of the HikiDoc nor the names of its
|
99
|
+
contributors may be used to endorse or promote products derived
|
100
|
+
from this software without specific prior written permission.
|
101
|
+
|
102
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
103
|
+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
104
|
+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
105
|
+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
106
|
+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
107
|
+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
108
|
+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
109
|
+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
110
|
+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
111
|
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
112
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
113
|
+
```
|
114
|
+
|
data/Rakefile
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
require "bundler/gem_tasks"
|
2
2
|
require 'rake/testtask'
|
3
3
|
|
4
|
+
release_task = Rake.application["release"]
|
5
|
+
# We use Trusted Publishing.
|
6
|
+
release_task.prerequisites.delete("build")
|
7
|
+
release_task.prerequisites.delete("release:rubygem_push")
|
8
|
+
release_task_comment = release_task.comment
|
9
|
+
if release_task_comment
|
10
|
+
release_task.clear_comments
|
11
|
+
release_task.comment = release_task_comment.gsub(/ and build.*$/, "")
|
12
|
+
end
|
13
|
+
|
4
14
|
Rake::TestTask.new do |t|
|
5
15
|
t.libs << "test"
|
6
16
|
t.test_files = FileList['test/**/*_test.rb']
|
data/TextFormattingRules.ja
CHANGED
@@ -133,14 +133,14 @@ http://jp.rubyist.net/theme/clover/clover_h1.png
|
|
133
133
|
���Τ褦�ˤ����''��Ĵ''�ˤʤ�ޤ���
|
134
134
|
�����ơ����Τ褦�ˤ����'''����˶�Ĵ'''����ޤ���
|
135
135
|
==���뤤����==����ˡ����ä����⥵�ݡ��Ȥ��Ƥ��ޤ���
|
136
|
-
|
136
|
+
�ޤ��ޤ������Τ褦�ˤ����``����ɽ��``�ˤʤ�ޤ���
|
137
137
|
|
138
138
|
*������
|
139
139
|
|
140
140
|
���Τ褦�ˤ����''��Ĵ''�ˤʤ�ޤ���
|
141
141
|
�����ơ����Τ褦�ˤ����'''����˶�Ĵ'''����ޤ���
|
142
142
|
==���뤤����==����ˡ����ä����⥵�ݡ��Ȥ��Ƥ��ޤ���
|
143
|
-
|
143
|
+
�ޤ��ޤ������Τ褦�ˤ����``����ɽ��``�ˤʤ�ޤ���
|
144
144
|
|
145
145
|
!����
|
146
146
|
|