Skip to content

Commit bc54bd2

Browse files
committed
refs #13 add nekochan directive sample to README
1 parent 059acd4 commit bc54bd2

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,21 @@ extensions = [
2424
]
2525
```
2626

27-
## Use `nekochan` role
27+
## Use `nekochan` role or directive
2828

29-
When you use the `nekochan` roll, you will see any nekochan emoji.
29+
When you use the `nekochan` roll or directive, you will see any nekochan emoji.
3030

3131
* markdown
3232

33-
```markdown
33+
````markdown
3434
Welcome to nekochan emoji {nekochan}`banzai` world!!
3535

3636
* Enjoy nekochan emoji {nekochan}`choo-choo-train`
3737
* I love {nekochan}`beer`
38+
39+
```{nekochan} melty
3840
```
41+
````
3942

4043
* reStructuredText
4144

@@ -44,6 +47,8 @@ Welcome to nekochan emoji :nekochan:`banzai` world!!
4447
4548
* Enjoy nekochan emoji :nekochan:`choo-choo-train`
4649
* I love :nekochan:`beer`
50+
51+
.. nekochan:: melty
4752
```
4853

4954
![nekochan emoji with text](https://raw.githubusercontent.com/takanory/sphinx-nekochan/main/nekochan-emoji-with-text.gif)
@@ -54,18 +59,29 @@ You can specify height and alt text with a semicolon(`;`) after the name of the
5459

5560
* markdown
5661

57-
```markdown
62+
````markdown
5863
* Big bear nekochan {nekochan}`kuma-nya;2em`
5964
* Huge hot-sprint nekochan {nekochan}`hot-spring;128px`
6065
* Customize alt text for emoji {nekochan}`gohan-taberu;3em;Nekochan eating rice ball`
66+
67+
68+
```{nekochan} lgtm
69+
:alt: Looks Good To Me
70+
:height: 3em
6171
```
72+
````
6273

6374
* reStructuredText
6475

6576
```rst
6677
* Big bear nekochan :nekochan:`kuma-nya;2em`
6778
* Huge hot-sprint nekochan :nekochan:`hot-spring;128px`
6879
* Customize alt text for emoji :nekochan:`gohan-taberu;3em;Nekochan eating rice ball`
80+
81+
82+
.. nekochan:: lgtm
83+
:alt: Looks Good To Me
84+
:height: 3em
6985
```
7086

7187
![customize emoji height and alt text](https://raw.githubusercontent.com/takanory/sphinx-nekochan/main/custom-height-alt.png)
@@ -76,16 +92,25 @@ Also, you can specify transform option with a semicolon(`;`) after the alt text
7692

7793
* markdown
7894

79-
```markdown
95+
````markdown
8096
* Skip {nekochan}`skip-nya;2em` rotated 90 degrees clockwise {nekochan}`skip-nya;2em;;rotate-90`
8197
* Flip the left and right side of the {nekochan}`yoshi;2em` Yoshi emoji {nekochan}`yoshi;2em;;flip-horizontal`
98+
99+
```{nekochan} snake
100+
:transform: flip-vertical
101+
:height: 2em
82102
```
103+
````
83104

84105
* reStructuredText
85106

86107
```rst
87108
* Skip :nekochan:`skip-nya;2em` rotated 90 degrees clockwise :nekochan:`skip-nya;2em;;rotate-90`
88109
* Flip the left and right side of the :nekochan:`yoshi;2em` Yoshi emoji :nekochan:`yoshi;2em;;flip-horizontal`
110+
111+
.. nekochan:: snake
112+
:transform: flip-vertical
113+
:height: 2em
89114
```
90115

91116
![Transform emoji](https://raw.githubusercontent.com/takanory/sphinx-nekochan/main/transform-emoji.png)

0 commit comments

Comments
 (0)