Skip to content

Commit aa8fa8e

Browse files
code-reaper08code-reaper08
committed
Added information about functions provided
1 parent 8f5e3db commit aa8fa8e

File tree

1 file changed

+218
-3
lines changed

1 file changed

+218
-3
lines changed

‎README.md

Lines changed: 218 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,218 @@
1-
# S
2-
on DEV
3-
![Gray Minimal Pencil Creative Studio Logo](https://user-images.githubusercontent.com/64256342/128370480-ce2bd62e-f599-4fd0-8e40-1391fe5ce250.gif)
1+
# SpectreMan
2+
<div align="center">
3+
4+
<img src="https://user-images.githubusercontent.com/64256342/128370480-ce2bd62e-f599-4fd0-8e40-1391fe5ce250.gif" alt="spectreman logo" width="200px">
5+
6+
</div>
7+
<div align="center">
8+
9+
**SpectreMan to your rescue**
10+
11+
</div>
12+
13+
## SpectreCSS:
14+
15+
SpectreCSS is a minimalistic CSS-only framework, which caught my eye, when i was searching for a pure CSS framework, giving me more flexibility and customization ability. When doing SpectreCSS, I got an idea to accomodate all the possible abilities of SpectreCSS into a ST package. I think SpectreCSS by itself is easy and smart, this autocomplete pacakage will add to its simplicity by providing ready to use snippets at your disposal.
16+
17+
18+
## Installation:
19+
### Package Control ![recommended](https://img.shields.io/badge/method-recommended-blue "Use this")
20+
21+
The easiest way to install the MarkdownAssistant is by using [Package Control](https://packagecontrol.io/). Installing it [is documented here](https://packagecontrol.io/installation).
22+
23+
24+
- Open Package Control (or hit Ctrl+Shift+P or Cmd+Shift+P)
25+
- Type _install_ and hit enter
26+
- Type MarkdownAssistant and hit enter again
27+
28+
---
29+
30+
## Downloading the Archive
31+
32+
>Use this method if you don’t have Package Control or Git
33+
34+
- Open [https://github.com/code-reaper08/S](https://github.com/code-reaper08/S) in your browser
35+
- On the right hand side there is a _Download ZIP_ button – click it
36+
- Go to _Preferences_ and _Browse packages…_ which opens the Packages directory
37+
- Extract the archive inside the Packages directory
38+
39+
To find out where the Packages directory is, you can go to _Preferences_ and _Browse packages…_. This will open the directory in your file explorer.
40+
41+
## Functions at your disposal:
42+
43+
### CDN
44+
Trigger word | function |
45+
| ------------- |:-------------:|
46+
| sp-cdn | CDN links |
47+
### Typography functions
48+
| Trigger word | function |
49+
| ------------- |:-------------:|
50+
| sp-bq | blockquote |
51+
| sp-dl | descriptionlist |
52+
| sp-h1 | H1 heading |
53+
| sp-ol | orderedList |
54+
| sp-p | Paragraph |
55+
| sp-ul | UnoderedList|
56+
57+
### Table functions
58+
| Trigger word | function |
59+
| ------------- |:-------------:|
60+
| sp-table | default table |
61+
| sp-table-scroll | Scrollable table |
62+
| sp-table-s | Striped Table |
63+
64+
### Semantic functions
65+
| Trigger word | function |
66+
| ------------- |:-------------:|
67+
| sp-abbr | abbreviation |
68+
| sp-b | Bold |
69+
| sp-cite | Citation |
70+
| sp-code | Type-Code |
71+
| sp-del | Deleted text |
72+
| sp-em | Emphasis text |
73+
| sp-mark | Highlighted text |
74+
| sp-ins | Inserted text |
75+
| sp-it | Italics |
76+
| sp-kbd | KeyBindings |
77+
| sp-rby | Ruby(For East-Asian typography) |
78+
| sp-out | Sample output |
79+
| sp-strike | Strikethrough |
80+
| sp-sub | Subscripted text |
81+
| sp-sup | Superscripted text |
82+
| sp-time | Time |
83+
| sp-uline | Underlined text |
84+
| sp-var | Variables |
85+
86+
### Navbar function
87+
| Trigger word | function |
88+
| ------------- |:-------------:|
89+
| sp-nav | Navbar default |
90+
91+
### Media functions
92+
| Trigger word | function |
93+
| ------------- |:-------------:|
94+
| sp-cap | figcaption |
95+
| sp-i-con | Auto cropped Image |
96+
| sp-i-cov | Image covers |
97+
| sp-img | Responsive image |
98+
| sp-v | Responsive video |
99+
100+
### Layout functions
101+
| Trigger word | function |
102+
| ------------- |:-------------:|
103+
| sp-col-12 | Column 12 |
104+
| sp-col-9 | Column 9 |
105+
| sp-col-6 | Column 6 |
106+
| sp-col-3 | Column 3 |
107+
108+
### Language functions
109+
| Trigger word | function |
110+
| ------------- |:-------------:|
111+
| sp-chs | chinese Simplified font support |
112+
| sp-cht | chinese traditional font support |
113+
| sp-j | japanese font support |
114+
| sp-ko | Korean font support |
115+
116+
### Lable functions
117+
| Trigger word | function |
118+
| ------------- |:-------------:|
119+
| sp-l | Label default |
120+
| sp-lerr | Label error |
121+
| sp-lp | Label primary |
122+
| sp-lsec |Label secondary |
123+
| sp-lsuc | Label success |
124+
| sp-lwarn | Label warning |
125+
126+
### Form functions
127+
| Trigger word | function |
128+
| ------------- |:-------------:|
129+
| sp-fchk | Form checkbox |
130+
| sp-fcolor | Color input |
131+
| sp-fdate | Date input |
132+
| sp-femail | Email input |
133+
| sp-ffile | File input |
134+
| sp-fhor | Horizontal sample form |
135+
| sp-finp | Form input |
136+
| sp-fload | Input loading |
137+
| sp-fnum | Number input |
138+
| sp-fpass | Password input |
139+
| sp-fr | Radio input |
140+
| sp-fsearch | Search input |
141+
| sp-fs | Form select |
142+
| sp-fswitch | Form switch |
143+
| sp-ftel | Telephone input |
144+
| sp-ftxt | Text area |
145+
| sp-furl | URL input |
146+
147+
### Component functions
148+
| Trigger word | function |
149+
| ------------- |:-------------:|
150+
| sp-acc | accordian |
151+
| sp-ava | Avatar |
152+
| sp-bdg | Badge default |
153+
| sp-bdg-btn | Badge with button |
154+
| sp-bc | Breadcrumbs |
155+
| sp-card | Card default |
156+
| sp-chips | Chips default |
157+
| sp-empty | Empty state |
158+
| sp-mod | Modal box |
159+
| sp-nav | Nav |
160+
| sp-pg1 | Pagination with pg_no |
161+
| sp-pg2 | Pagination prev-next type |
162+
| sp-pnl | panel |
163+
| sp-bpop | Bottom popover |
164+
| sp-lpop | Left popover |
165+
| sp-rpop | Right popover |
166+
| sp-tpop | Top popover |
167+
| sp-sl-t | Slider with tool tip |
168+
| sp-sl | Slider default |
169+
| sp-stp | Steps |
170+
| sp-tile1 | Tiles type1 |
171+
| sp-ftile | File tile |
172+
| sp-tt | Tooltip |
173+
174+
### Code function
175+
| Trigger word | function |
176+
| ------------- |:-------------:|
177+
| sp-codem | Code snippet |
178+
179+
### Button functions
180+
| Trigger word | function |
181+
| ------------- |:-------------:|
182+
| sp-btn-menu | Menu Action button |
183+
| sp-btn-menu-c | Menu Action Round button |
184+
| sp-btn | Button default |
185+
| sp-btn-dis | Disabled button |
186+
| sp-btn-e | Error button (red) |
187+
| sp-btn-grp | Button group |
188+
| sp-btn-lnk |Link button |
189+
| sp-btn-load | Loading button |
190+
| sp-btn-p | Primary button |
191+
| sp-btn-s | Success button (green) |
192+
193+
194+
## License:
195+
196+
```
197+
MIT License
198+
199+
Copyright (c) 2021 Vishwa.R
200+
201+
Permission is hereby granted, free of charge, to any person obtaining a copy
202+
of this software and associated documentation files (the "Software"), to deal
203+
in the Software without restriction, including without limitation the rights
204+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
205+
copies of the Software, and to permit persons to whom the Software is
206+
furnished to do so, subject to the following conditions:
207+
208+
The above copyright notice and this permission notice shall be included in all
209+
copies or substantial portions of the Software.
210+
211+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
212+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
213+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
214+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
215+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
216+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
217+
SOFTWARE.
218+
```

0 commit comments

Comments
 (0)