Skip to content

Commit

Permalink
Merge pull request #43 from mgalgs/master
Browse files Browse the repository at this point in the history
README.md: Re-generate
  • Loading branch information
coldnew authored Oct 25, 2022
2 parents f928989 + b8698ad commit 2303013
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 8 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ all: pangu-spacing.elc

README.md: make-readme-markdown.el
emacs --script $< <pangu-spacing.el>$@ 2>/dev/null
sed -i '1s%^%<a href="https://github.com/coldnew/pangu-spacing.el"><img src="https://www.gnu.org/software/emacs/images/emacs.png" alt="Normalize Logo" width="80" height="80" align="right"></a> \n%' $@

make-readme-markdown.el:
wget -q -O $@ https://raw.github.com/mgalgs/make-readme-markdown/master/make-readme-markdown.el
Expand Down
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<a href="https://github.com/coldnew/pangu-spacing.el"><img src="https://www.gnu.org/software/emacs/images/emacs.png" alt="Normalize Logo" width="80" height="80" align="right"></a>
<a href="http://github.com/coldnew/pangu-spacing"><img src="https://www.gnu.org/software/emacs/images/emacs.png" alt="Emacs Logo" width="80" height="80" align="right"></a>
## pangu-spacing.el
*Minor-mode to add space between Chinese and English characters.*

---
[![License GPLv3](https://img.shields.io/badge/license-GPL_v3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.html)
[![Build Status](https://travis-ci.org/coldnew/pangu-spacing.svg?branch=master)](https://travis-ci.org/coldnew/pangu-spacing)
[![MELPA](http://melpa.org/packages/pangu-spacing-badge.svg)](http://melpa.org/#/pangu-spacing)
[![MELPA Stable](http://stable.melpa.org/packages/pangu-spacing-badge.svg)](http://stable.melpa.org/#/pangu-spacing)

Expand Down Expand Up @@ -115,15 +116,36 @@ this: (take org-mode as example)
(set (make-local-variable 'pangu-spacing-real-insert-separtor) t)))


### Function Documentation


#### `(pangu-spacing-search-buffer REGEXP START END FUNC)`
### Customization Documentation

#### `pangu-spacing-separator`

String to be display between Chinese and English.

#### `pangu-spacing-real-insert-separtor`

Set t or nil to make space show only on overlay or insert in file.
When you set t here, the space will be insert when you save file.

#### `pangu-spacing-inhibit-mode-alist`

Inhibit mode alist for pangu-spacing-mode.

#### `pangu-spacing-special-region-func-alist`

Alist mapping major-mode to the corresponding function to
check for special region that shall not write real pangu-space

### Function and Macro Documentation

#### `(pangu-spacing-search-buffer REGEXP START END FUNC)` (macro)

Helper macro to search buffer and do func according regexp for
pangu-spacing-mode.

#### `(pangu-spacing-search-overlay BEG END FUNC REGEXP)`
#### `(pangu-spacing-search-overlay BEG END FUNC REGEXP)` (macro)

Helper macro to search and update overlay according func and regexp for
pangu-sapce-mode.
Expand Down Expand Up @@ -165,7 +187,7 @@ Delete all pangu-spacing-overlays in BUFFER.

Space current buffer.
It will really insert separator, no matter what
pangu-spacing-real-insert-separtor is.
`pangu-spacing-real-insert-separtor` is.

-----
<div style="padding-top:15px;color: #d0d0d0;">
Expand Down
3 changes: 1 addition & 2 deletions pangu-spacing.el
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
;; Kyewords: converience
;; Version: 0.4
;; X-URL: http://github.com/coldnew/pangu-spacing
;; URL: http://github.com/coldnew/pangu-spacing

;; This file is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Expand All @@ -22,8 +23,6 @@


;;; Commentary:
;; [![MELPA](http://melpa.org/packages/pangu-spacing-badge.svg)](http://melpa.org/#/pangu-spacing)
;; [![MELPA Stable](http://stable.melpa.org/packages/pangu-spacing-badge.svg)](http://stable.melpa.org/#/pangu-spacing)

;;; Screenshot:
;; ![Screenshot](https://github.com/coldnew/pangu-spacing/raw/master/screenshot/screenshot.gif)
Expand Down

0 comments on commit 2303013

Please sign in to comment.