-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
165 lines (147 loc) · 6.42 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!doctype html>
<html lang="en" id="top">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="robots" content="INDEX, FOLLOW" />
<meta
name="description"
content="A class-less CSS design system framework that utilizes the power of data-attributes for styling components."
/>
<meta name="author" content="Jacob Perez" />
<meta property="og:image" content="./banner.jpg" />
<title>Rams - Class-Less CSS Design System Framework</title>
<link rel="icon" href="./favicon.svg" />
<link rel="preload" href="templates/index.html" as="fetch" type="text/html" crossorigin />
<link rel="stylesheet" href="css/index.css" />
<script src="./js/modules/meta.js/"></script>
<script type="module" src="./js/index.js"></script>
<script>
meta.type = "post";
meta.title = "Getting Started";
</script>
</head>
<body>
<template id="headerTemplate">
<p data-flex="wrap">
<span data-item="grow">Learn more about Rams and how to get started.</span>
<span data-icon="">
<a href="https://github.com/jacobxperez/rams/blob/master/src/docs/index.html"
>Edit Page</a
>
</span>
</p>
</template>
<template id="contentTemplate">
<p>
Start by
<strong
><a href="https://github.com/jacobxperez/rams/archive/master.zip"
>downloading</a
></strong
>
the
<a href="https://github.com/jacobxperez/rams">repository</a> or by cloning the
project:
</p>
<pre
data-box="padding border"
><code>git clone https://github.com/jacobxperez/rams.git</code></pre>
<p>
Install dependencies on your machine with
<a href="https://www.npmjs.com/" rel="nofollow">npm</a>
</p>
<pre data-box="padding border"><code>npm install</code></pre>
<h3 id="build">Build</h3>
<p>
Edit the
<a href="https://github.com/jacobxperez/rams/blob/master/src/css/settings.css"
>settings</a
>, add
<a href="https://github.com/jacobxperez/rams/tree/master/src/css/custom">custom</a>
modules and linked them to
<a href="https://github.com/jacobxperez/rams/blob/master/src/css/index.css"
>index.css</a
>
for compiling.
</p>
<ul data-list="ul">
<li>
<a href="https://github.com/jacobxperez/rams/tree/master/src/css/">/css</a>
<ul data-list="ul">
<li>
<a href="https://github.com/jacobxperez/rams/tree/master/src/css/core"
>core</a
>
(important files for compiling)
</li>
<li>
<a href="https://github.com/jacobxperez/rams/tree/master/src/css/custom"
>custom</a
>
(add custom modules here)
</li>
<li>
<a
href="https://github.com/jacobxperez/rams/blob/master/src/css/index.css"
>index.css</a
>
(compile to produce the final CSS)
</li>
<li>
<a
href="https://github.com/jacobxperez/rams/blob/master/src/css/settings.css"
>settings.css</a
>
(theme settings for fonts, colors, and more)
</li>
</ul>
</li>
</ul>
<h3 id="compile">Compile</h3>
<p>On your terminal run these scripts to compile build</p>
<ul data-list="ul">
<li><code>npm run docs</code> (locally runs documentation)</li>
<li><code>npm run dev</code> (serve current development build)</li>
<li>
<code>npm run build</code> (makes current build and sets url to "/" can be
changed on
<a href="https://github.com/jacobxperez/rams/blob/master/package.json"
>package.json</a
>)
</li>
</ul>
<h3 id="contributing">Contributing</h3>
<p>
If you are interested in contributing to this project, please read our
<a href="https://github.com/jacobxperez/rams/blob/master/.github/CONTRIBUTING.md"
>contributing-guidelines</a
>.
</p>
<h3 id="license">LICENSE</h3>
<p>
Copyright (C) 2024
<a href="https://jacobxperez.github.io/blog/">Jacob Perez</a>
</p>
<p>
Licensed under the
<a href="http://www.apache.org/licenses/LICENSE-2.0" rel="nofollow"
>Apache License, Version 2.0</a
>
(the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at
</p>
<p>
<a href="http://www.apache.org/licenses/LICENSE-2.0" rel="nofollow"
>http://www.apache.org/licenses/LICENSE-2.0</a
>
</p>
<p>
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License.
</p>
</template>
</body>
</html>