Skip to content

Commit eef2c39

Browse files
committed
updated frames docs
1 parent 0d2d059 commit eef2c39

File tree

10 files changed

+108
-49
lines changed

10 files changed

+108
-49
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# frames
22

3-
CLI tool to initialize projects with templates
3+
With frames, you can skip setup and focus on building. Choose from ready-to-use templates, with custom CSS and pre-integrated utilities. Build faster and smarter!
44

55
### Pre-requisites
66

@@ -13,4 +13,4 @@ CLI tool to initialize projects with templates
1313
npm create @pr4j3sh/frames@latest <template_name> myproject
1414
```
1515

16-
> [Available Templates](https://pr4j3sh.vercel.app/projects/frames)
16+
> [Browse Templates](https://pr4j3sh.github.io/frames/templates)

docs/guides/guides.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
const component = `<article class="card">
2+
<article class="card-body">
3+
<h6>Guides</h6>
4+
<p>Will be available soon. Check back later.</p>
5+
<article/>
6+
</article>`;
7+
8+
const none = document.getElementById("none");
9+
10+
none.innerHTML = component;

docs/guides/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44
<body>
55
<div class="container">
66
<div id="navbar"></div>
7-
<main id="guides">guides</main>
7+
<main id="guides">
8+
<article id="none"></article>
9+
</main>
810
<div id="footer"></div>
911
</div>
1012
<script type="module" src="/main.js"></script>
13+
<script type="module" src="guides.js"></script>
1114
</body>
1215
</html>

docs/main.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@ import "./src/components/head";
33
import "./src/components/navbar";
44
import "./src/lib/theme";
55
import "./src/components/footer";
6-
import "./src/components/templates";

docs/request/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44
<body>
55
<div class="container">
66
<div id="navbar"></div>
7-
<main id="">make a request</main>
7+
<main id="request">
8+
<article id="none"></article>
9+
</main>
810
<div id="footer"></div>
911
</div>
1012
<script type="module" src="/main.js"></script>
13+
<script type="module" src="request.js"></script>
1114
</body>
1215
</html>

docs/request/request.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
const component = `<article class="card">
2+
<article class="card-body">
3+
<h6>Request a template</h6>
4+
<p>Mail us @ <a class="link" href="mailto:prajesh.eleven118@gmail.com">prajesh.eleven118@gmail.com</a> .</p>
5+
<article/>
6+
</article>`;
7+
8+
const none = document.getElementById("none");
9+
10+
none.innerHTML = component;

docs/src/components/templates.js

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/templates/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88
<div id="footer"></div>
99
</div>
1010
<script type="module" src="/main.js"></script>
11+
<script type="module" src="template.js"></script>
1112
</body>
1213
</html>

docs/templates/template.js

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
const items = [
2+
{
3+
repo: "rust",
4+
title: "Rust Package/Library",
5+
tech: ["Rust", "Library", "Package"],
6+
},
7+
{
8+
repo: "express-vercel",
9+
title: "Express + Vercel",
10+
tech: ["Javascript", "API", "Express", "Vercel", "Backend", "Server"],
11+
url: "https://express-vercel-frames.vercel.app/",
12+
},
13+
{
14+
repo: "express",
15+
title: "Express",
16+
tech: ["Javascript", "API", "Express", "Backend", "Server"],
17+
},
18+
{
19+
repo: "js-tw",
20+
title: "Javascript + Tailwind",
21+
tech: ["Javascript", "Tailwind", "HTML", "CSS", "Frontend", "Vanilla"],
22+
url: "https://pr4j3sh.github.io/js-tw/",
23+
},
24+
{
25+
repo: "react-tw",
26+
title: "React + Tailwind",
27+
tech: ["React", "Tailwind", "React Router", "Frontend"],
28+
url: "https://react-tw-frames.vercel.app/",
29+
},
30+
{
31+
repo: "react-firebase",
32+
title: "React + Firebase",
33+
tech: [
34+
"React",
35+
"Firebase",
36+
"Tailwind",
37+
"React Router",
38+
"Redux Toolkit",
39+
"Frontend",
40+
],
41+
url: "https://react-firebase-frames.vercel.app/",
42+
},
43+
];
44+
45+
const templates = document.getElementById("templates");
46+
47+
const html = items
48+
.map((item) => {
49+
const tags = item.tech
50+
.map((tag) => {
51+
return `<code>${tag}</code>`;
52+
})
53+
.join("");
54+
const url = item.url
55+
? `<a class="link" href="${item.url}" target="_blank">template</a><span>/</span>`
56+
: "";
57+
return `<article>
58+
<span class="tag">${item.repo}</span>
59+
<h6>${item.title}</h6>
60+
<article class="btns">${tags}</article>
61+
<pre><code>npm create @pr4j3sh/frames@latest ${item.repo} myapp</code></pre>
62+
<article class="btns">
63+
${url}
64+
<a class="link" href="https://github.com/pr4j3sh/${item.repo}/" target="_blank">github</a>
65+
</article>
66+
</article>`;
67+
})
68+
.join("");
69+
70+
templates.innerHTML = html;

package.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@pr4j3sh/create-frames",
3-
"version": "1.0.9",
3+
"version": "1.0.10",
44
"description": "frames CLI tool for cloning templates",
55
"main": "dist/bundle.js",
66
"bin": {
@@ -15,9 +15,11 @@
1515
"dist"
1616
],
1717
"keywords": [
18-
"template",
19-
"boilerplate",
20-
"framework"
18+
"templates",
19+
"boilerplates",
20+
"frameworks",
21+
"libraries",
22+
"frames"
2123
],
2224
"author": "Prajesh Pratap Singh <prajesh.eleven118@gmail.com> (https://pr4j3sh.vercel.app/)",
2325
"license": "MIT",
@@ -28,7 +30,7 @@
2830
"bugs": {
2931
"url": "https://github.com/pr4j3sh/frames/issues"
3032
},
31-
"homepage": "https://github.com/pr4j3sh/frames#readme",
33+
"homepage": "https://pr4j3sh.github.io/frames/",
3234
"devDependencies": {
3335
"esbuild": "^0.24.0"
3436
}

0 commit comments

Comments
 (0)