Skip to content

Commit 7cb4e8f

Browse files
shainilpsshainilps
committed
renamed project to vulphix
1 parent 0ee76dc commit 7cb4e8f

File tree

14 files changed

+83
-77
lines changed

14 files changed

+83
-77
lines changed

‎README.md‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
# vulpix
2-
a markdown SSG generator for documentation site. Simple, Minimal with yaml config.
1+
# vulphix
2+
3+
a markdown SSG generator for documentation site. Simple, Minimal with yaml config.
34

45
## Usage
6+
57
```bash
6-
vulpix init #TODO
7-
vulpix build
8-
vulpix preview
8+
vulphix init #TODO
9+
vulphix build
10+
vulphix preview
911
```
1012

11-
vulpix.config.yaml
13+
vulphix.config.yaml
14+
1215
```yaml
1316
# customization
1417
title: site-name
@@ -21,30 +24,33 @@ sidebar:
2124
- title: Basics
2225
pages:
2326
- - Getting started
24-
- /basic/setup #(setup == setup.md)
27+
- /basic/setup #(setup == setup.md)
2528
- title: Links
2629
pages:
2730
- - Github
2831
- https://github.com/username
2932
```
33+
3034
Note:
35+
3136
- index.md which reside in your source root will be your home page
3237
- put favicon.ico in root of source for chooseing it as favicon of your site
3338
3439
## Feature
40+
3541
- [x] fixed template (for now)
3642
- [ ] syntax highlight support for (Go, JavaScript, TypeScript)
3743
- [x] build preview
3844
- [x] left side bar navigation for site
3945
- [ ] go releaser
40-
- [ ] vulpix init
46+
- [ ] vulphix init
4147
- [ ] right side bar navigation for page
4248
- [ ] deploy to some cloud
4349
- [ ] ci/cd generator for project (Future plan)
4450
- [ ] Hot reload (Future plan)
4551
46-
4752
## Contributing
48-
open for contribution. you can fork repo, create a issue and make a PR. (that's all)
53+
54+
open for contribution. you can fork repo, create a issue and make a PR. (that's all)
4955
5056
<center>happy coding<3 <center/>

‎cmd/preview/preview.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"path"
1111
"path/filepath"
1212

13-
"github.com/codeshaine/vulpix/cmd/build"
13+
"github.com/codeshaine/vulphix/cmd/build"
1414
)
1515

1616
const previewPort = 8080

‎docs/dist/basics/configfile.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
<head>
44
<meta charset="UTF-8" />
55
<title>Configuration file</title>
6-
<meta name="description" content="this is the docs of your vulpix" />
6+
<meta name="description" content="this is the docs of your vulphix" />
77
<meta name="author" content="https://x.com/codeshaine" />
88
<meta name="og:title" content="Configuration file" />
9-
<meta name="og:description" content="this is the docs of your vulpix" />
10-
<meta name="og:url" content="doc.vulpix.com" />
9+
<meta name="og:description" content="this is the docs of your vulphix" />
10+
<meta name="og:url" content="doc.vulphix.com" />
1111
<meta name="viewport" content="width=device-width, initial-scale=1" />
1212

1313
<link rel="preconnect" href="https://fonts.googleapis.com" />
@@ -34,15 +34,15 @@
3434

3535
<header class="mobile-header">
3636
<button class="mobile-nav-toggle" id="mobileNavToggle">☰</button>
37-
<a href="/" class="mobile-logo">Vulpix</a>
37+
<a href="/" class="mobile-logo">vulphix</a>
3838
</header>
3939

4040
<button class="theme-toggle" onclick="toggleTheme()" id="themeToggle">
4141
🌙
4242
</button>
4343

4444
<nav class="bar" id="sidebar">
45-
<a href="/" class="logo"> Vulpix </a>
45+
<a href="/" class="logo"> vulphix </a>
4646
<div class="container">
4747

4848
<section>
@@ -80,7 +80,7 @@ <h3>Links</h3>
8080
<ul>
8181

8282
<li>
83-
<a href="https://github.com/codeshaine/vulpix">Github</a>
83+
<a href="https://github.com/codeshaine/vulphix">Github</a>
8484
</li>
8585

8686
<li>
@@ -94,12 +94,12 @@ <h3>Links</h3>
9494
</nav>
9595
<main class="content">
9696
<h1>Configuration file</h1>
97-
<p>As of right now config file of vulpix is very minmal. you don't get lot of features like you get from feature rich ssg like hugo or even the astro starlight. This ssg is simple, minimal and was designed for me</p>
97+
<p>As of right now config file of vulphix is very minmal. you don't get lot of features like you get from feature rich ssg like hugo or even the astro starlight. This ssg is simple, minimal and was designed for me</p>
9898
<p>Unlike other SSGs I am using YAML format as the config type, because It is more elegant to look at.</p>
9999
<p>config file:</p>
100-
<pre><code class="language-yaml">title: Vulpix
101-
domain: doc.vulpix.com # (optional)
102-
description: this is the docs of your vulpix
100+
<pre><code class="language-yaml">title: Vulphix
101+
domain: doc.vulphix.com # (optional)
102+
description: this is the docs of your vulphix
103103
handle: https://x.com/codeshaine
104104
source: doc/src
105105
build: dist

‎docs/dist/basics/installation.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
<head>
44
<meta charset="UTF-8" />
55
<title>Instllation Process</title>
6-
<meta name="description" content="this is the docs of your vulpix" />
6+
<meta name="description" content="this is the docs of your vulphix" />
77
<meta name="author" content="https://x.com/codeshaine" />
88
<meta name="og:title" content="Instllation Process" />
9-
<meta name="og:description" content="this is the docs of your vulpix" />
10-
<meta name="og:url" content="doc.vulpix.com" />
9+
<meta name="og:description" content="this is the docs of your vulphix" />
10+
<meta name="og:url" content="doc.vulphix.com" />
1111
<meta name="viewport" content="width=device-width, initial-scale=1" />
1212

1313
<link rel="preconnect" href="https://fonts.googleapis.com" />
@@ -34,15 +34,15 @@
3434

3535
<header class="mobile-header">
3636
<button class="mobile-nav-toggle" id="mobileNavToggle">☰</button>
37-
<a href="/" class="mobile-logo">Vulpix</a>
37+
<a href="/" class="mobile-logo">vulphix</a>
3838
</header>
3939

4040
<button class="theme-toggle" onclick="toggleTheme()" id="themeToggle">
4141
🌙
4242
</button>
4343

4444
<nav class="bar" id="sidebar">
45-
<a href="/" class="logo"> Vulpix </a>
45+
<a href="/" class="logo"> vulphix </a>
4646
<div class="container">
4747

4848
<section>
@@ -80,7 +80,7 @@ <h3>Links</h3>
8080
<ul>
8181

8282
<li>
83-
<a href="https://github.com/codeshaine/vulpix">Github</a>
83+
<a href="https://github.com/codeshaine/vulphix">Github</a>
8484
</li>
8585

8686
<li>
@@ -96,7 +96,7 @@ <h3>Links</h3>
9696
<h1>Instllation Process</h1>
9797
<p>Inroder to install the tool, you need to have Golang installed. If not you can download that <a href="https://go.dev/doc/install">here</a>.</p>
9898
<p>After installing Go, you can install this tool by one command</p>
99-
<pre><code class="language-bash">go install github.com/codeshaine/vulpix@latest
99+
<pre><code class="language-bash">go install github.com/codeshaine/vulphix@latest
100100
</code></pre>
101101
<p>will update the docs once go releaser is set</p>
102102

‎docs/dist/basics/usage.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
<head>
44
<meta charset="UTF-8" />
55
<title>Simple Usage</title>
6-
<meta name="description" content="this is the docs of your vulpix" />
6+
<meta name="description" content="this is the docs of your vulphix" />
77
<meta name="author" content="https://x.com/codeshaine" />
88
<meta name="og:title" content="Simple Usage" />
9-
<meta name="og:description" content="this is the docs of your vulpix" />
10-
<meta name="og:url" content="doc.vulpix.com" />
9+
<meta name="og:description" content="this is the docs of your vulphix" />
10+
<meta name="og:url" content="doc.vulphix.com" />
1111
<meta name="viewport" content="width=device-width, initial-scale=1" />
1212

1313
<link rel="preconnect" href="https://fonts.googleapis.com" />
@@ -34,15 +34,15 @@
3434

3535
<header class="mobile-header">
3636
<button class="mobile-nav-toggle" id="mobileNavToggle">☰</button>
37-
<a href="/" class="mobile-logo">Vulpix</a>
37+
<a href="/" class="mobile-logo">vulphix</a>
3838
</header>
3939

4040
<button class="theme-toggle" onclick="toggleTheme()" id="themeToggle">
4141
🌙
4242
</button>
4343

4444
<nav class="bar" id="sidebar">
45-
<a href="/" class="logo"> Vulpix </a>
45+
<a href="/" class="logo"> vulphix </a>
4646
<div class="container">
4747

4848
<section>
@@ -80,7 +80,7 @@ <h3>Links</h3>
8080
<ul>
8181

8282
<li>
83-
<a href="https://github.com/codeshaine/vulpix">Github</a>
83+
<a href="https://github.com/codeshaine/vulphix">Github</a>
8484
</li>
8585

8686
<li>
@@ -94,18 +94,18 @@ <h3>Links</h3>
9494
</nav>
9595
<main class="content">
9696
<h1>Simple Usage</h1>
97-
<p>you can get stared with vulipx right after you install, vulpix support two commands for now</p>
97+
<p>you can get stared with vulipx right after you install, vulphix support two commands for now</p>
9898
<p>build: this command will build the static site for your markdowns</p>
99-
<pre><code class="language-bash">vulpix build
99+
<pre><code class="language-bash">vulphix build
100100
</code></pre>
101101
<p>preview: this command will serve the build</p>
102-
<pre><code class="language-bash">vulpix preview
102+
<pre><code class="language-bash">vulphix preview
103103
</code></pre>
104104
<p>well inorder to build you need config file,
105105
example config file</p>
106-
<pre><code class="language-yaml">title: Vulpix
107-
domain: doc.vulpix.com # (optional)
108-
description: this is the docs of your vulpix
106+
<pre><code class="language-yaml">title: vulphix
107+
domain: doc.vulphix.com # (optional)
108+
description: this is the docs of your vulphix
109109
handle: https://x.com/codeshaine
110110
source: doc/src
111111
build: dist

‎docs/dist/guides/deploy.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
<head>
44
<meta charset="UTF-8" />
55
<title>Deploying guide</title>
6-
<meta name="description" content="this is the docs of your vulpix" />
6+
<meta name="description" content="this is the docs of your vulphix" />
77
<meta name="author" content="https://x.com/codeshaine" />
88
<meta name="og:title" content="Deploying guide" />
9-
<meta name="og:description" content="this is the docs of your vulpix" />
10-
<meta name="og:url" content="doc.vulpix.com" />
9+
<meta name="og:description" content="this is the docs of your vulphix" />
10+
<meta name="og:url" content="doc.vulphix.com" />
1111
<meta name="viewport" content="width=device-width, initial-scale=1" />
1212

1313
<link rel="preconnect" href="https://fonts.googleapis.com" />
@@ -34,15 +34,15 @@
3434

3535
<header class="mobile-header">
3636
<button class="mobile-nav-toggle" id="mobileNavToggle">☰</button>
37-
<a href="/" class="mobile-logo">Vulpix</a>
37+
<a href="/" class="mobile-logo">vulphix</a>
3838
</header>
3939

4040
<button class="theme-toggle" onclick="toggleTheme()" id="themeToggle">
4141
🌙
4242
</button>
4343

4444
<nav class="bar" id="sidebar">
45-
<a href="/" class="logo"> Vulpix </a>
45+
<a href="/" class="logo"> vulphix </a>
4646
<div class="container">
4747

4848
<section>
@@ -80,7 +80,7 @@ <h3>Links</h3>
8080
<ul>
8181

8282
<li>
83-
<a href="https://github.com/codeshaine/vulpix">Github</a>
83+
<a href="https://github.com/codeshaine/vulphix">Github</a>
8484
</li>
8585

8686
<li>

‎docs/dist/index.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
<html lang="en">
33
<head>
44
<meta charset="UTF-8" />
5-
<title>Vulpix Documentation</title>
6-
<meta name="description" content="this is the docs of your vulpix" />
5+
<title>Vulphix Documentation</title>
6+
<meta name="description" content="this is the docs of your vulphix" />
77
<meta name="author" content="https://x.com/codeshaine" />
8-
<meta name="og:title" content="Vulpix Documentation" />
9-
<meta name="og:description" content="this is the docs of your vulpix" />
10-
<meta name="og:url" content="doc.vulpix.com" />
8+
<meta name="og:title" content="Vulphix Documentation" />
9+
<meta name="og:description" content="this is the docs of your vulphix" />
10+
<meta name="og:url" content="doc.vulphix.com" />
1111
<meta name="viewport" content="width=device-width, initial-scale=1" />
1212

1313
<link rel="preconnect" href="https://fonts.googleapis.com" />
@@ -34,15 +34,15 @@
3434

3535
<header class="mobile-header">
3636
<button class="mobile-nav-toggle" id="mobileNavToggle">☰</button>
37-
<a href="/" class="mobile-logo">Vulpix</a>
37+
<a href="/" class="mobile-logo">vulphix</a>
3838
</header>
3939

4040
<button class="theme-toggle" onclick="toggleTheme()" id="themeToggle">
4141
🌙
4242
</button>
4343

4444
<nav class="bar" id="sidebar">
45-
<a href="/" class="logo"> Vulpix </a>
45+
<a href="/" class="logo"> vulphix </a>
4646
<div class="container">
4747

4848
<section>
@@ -80,7 +80,7 @@ <h3>Links</h3>
8080
<ul>
8181

8282
<li>
83-
<a href="https://github.com/codeshaine/vulpix">Github</a>
83+
<a href="https://github.com/codeshaine/vulphix">Github</a>
8484
</li>
8585

8686
<li>
@@ -93,8 +93,8 @@ <h3>Links</h3>
9393
</div>
9494
</nav>
9595
<main class="content">
96-
<h1>Vulpix Documentation</h1>
97-
<p><strong>Vulpix</strong> is simple, elegant, minimal SSG for your next docs. This project was developed by <a href="https://github.com/codeshaine">codeshaine</a> for fun. there are better alternatives if you want to have customizability and other things. If you still want to use this then go ahead I won't stop you haha</p>
96+
<h1>Vulphix Documentation</h1>
97+
<p><strong>Vulphix</strong> is simple, elegant, minimal SSG for your next docs. This project was developed by <a href="https://github.com/codeshaine">codeshaine</a> for fun. there are better alternatives if you want to have customizability and other things. If you still want to use this then go ahead I won't stop you haha</p>
9898
<p>PS: I forgot to mention This project idea is heavily inspired by <a href="https://malta.pilcrowonpaper.com">malta</a></p>
9999

100100
</main>

‎docs/src/basics/configfile.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
title: Configuration file
33
---
44

5-
As of right now config file of vulpix is very minmal. you don't get lot of features like you get from feature rich ssg like hugo or even the astro starlight. This ssg is simple, minimal and was designed for me
5+
As of right now config file of vulphix is very minmal. you don't get lot of features like you get from feature rich ssg like hugo or even the astro starlight. This ssg is simple, minimal and was designed for me
66

77
Unlike other SSGs I am using YAML format as the config type, because It is more elegant to look at.
88

99
config file:
1010

1111
```yaml
12-
title: Vulpix
13-
domain: doc.vulpix.com # (optional)
14-
description: this is the docs of your vulpix
12+
title: Vulphix
13+
domain: doc.vulphix.com # (optional)
14+
description: this is the docs of your vulphix
1515
handle: https://x.com/codeshaine
1616
source: doc/src
1717
build: dist

‎docs/src/basics/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ Inroder to install the tool, you need to have Golang installed. If not you can d
66

77
After installing Go, you can install this tool by one command
88
```bash
9-
go install github.com/codeshaine/vulpix@latest
9+
go install github.com/codeshaine/vulphix@latest
1010
```
1111
will update the docs once go releaser is set

0 commit comments

Comments
 (0)