Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cognitom/keiyaku-css
Crazy Style Formatter for Japanese Contract Document
https://github.com/cognitom/keiyaku-css
Last synced: about 1 month ago
JSON representation
Crazy Style Formatter for Japanese Contract Document
- Host: GitHub
- URL: https://github.com/cognitom/keiyaku-css
- Owner: cognitom
- License: mit
- Created: 2017-01-07T09:55:13.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-09T04:34:02.000Z (almost 8 years ago)
- Last Synced: 2024-09-18T20:24:29.254Z (about 2 months ago)
- Language: CSS
- Homepage: https://cognitom.github.io/keiyaku-css/
- Size: 23.4 KB
- Stars: 107
- Watchers: 8
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Keiyaku CSS
> Crazy Style Formatter for Japanese Contract Document
Unfortunately, the style in Japanese contract document is totally crazy. I hope this CSS library cures that a bit:
0. write a document logically structured in markdown or HTML,
0. apply `keiyaku-css` to it
0. then, you'll get a well-formed document
0. *good luck!*
## 概要
Keiyaku CSS（以下、「本件ライブラリ」という。）は、Markdownで書かれた契約文書を、適切な印刷書式にスタイリングするための、CSSライブラリです。
ユーザ（以下、「甲」という。）は、製作者（以下、「乙」という。）が開発した本件ライブラリについて、以下のとおり使用することが可能です。
## 目的
本件ライブラリの目的は、法務の方からダメ出しされないことです。
## インストール
[ここからCSSファイルをダウンロード](https://raw.githubusercontent.com/cognitom/keiyaku-css/master/keiyaku.css)するか、npm経由でインストールします。
```bash
$ npm install --save keiyaku-css
```
HTMLの`HEAD`内にCSSファイルを読み込みます。
```html
```
本件ライブラリを使用したいセクションに、`keiyaku`クラスを付加します。(`div`タグなどでも構いません)
```html
```
上記セクション内に、必要なHTMLを書き入れます。
## 使い方・HTML編
HTMLを手書きする場合は、次の要素を使います。
- `
文書のタイトル
`
- `見出しタイトル(条)
`
- `- 箇条書き
- `
- 箇条書き(連番)
- 署名欄・項目
- `
- `
` 署名欄の開始
- `
署名欄・見出し
`- `
## 使い方・Markdown編
本件ライブラリの使用が想定されているのは、主にMarkdownを使う場合です。下記のように書くことで可読性の高い契約文書を作成でき(ると期待し)ます。
- 文書のタイトル: `#`
- 見出しタイトル(条): `##`
- 箇条書き: `-`
- 箇条書き(連番): `1.`, `2.`, ...
- 署名欄: `---`で始める
- 署名欄・見出し: `####`
- 署名欄・項目: `-` (最後の項目には、自動的に`印`マークが付きます)
## 使用例
- [建物賃貸借契約書](https://cognitom.github.io/keiyaku-css/example/contract) ([markdown](https://raw.githubusercontent.com/cognitom/keiyaku-css/master/example/contract.md))
## エディタで使う
下記のテーマファイルを、所定のフォルダに読み込みます。
- [テーマファイル for Caret](https://raw.githubusercontent.com/cognitom/keiyaku-css/master/editor-support/keiyaku-caret.css)
- [テーマファイル for Marked 2](https://raw.githubusercontent.com/cognitom/keiyaku-css/master/editor-support/keiyaku-marked2.css)
## ライセンス
MIT © Tsutomu Kawamura
---
2017年1月吉日
#### 甲
- 住所:
- 氏名: Your Name
#### 乙
- 住所: 東京都世田谷区 下北沢オープンソースCafe
- 氏名: Tsutomu Kawamura