Skip to content

Commit 9446e21

Browse files
Initialize VitePress
- Add theme submodule - Add initial configuration files - Override theme-default VPHero/VPFooter with custom theme version - Update README
1 parent afcba54 commit 9446e21

File tree

7 files changed

+2424
-28
lines changed

7 files changed

+2424
-28
lines changed

.gitignore

+4-22
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,14 @@
1-
# Vim
2-
*~
3-
*.sw[p_]
4-
5-
# Sublime Text
6-
*.sublime-project
7-
*.sublime-workspace
8-
9-
# Ruby Gem
10-
*.gem
11-
.bundle
12-
Gemfile.lock
13-
**/vendor/bundle
14-
151
# Node.js and NPM
162
node_modules
173
npm-debug.log*
18-
package-lock.json
194
codekit-config.json
205

6+
# VitePress
7+
docs/.vitepress/cache
8+
docs/.vitepress/dist
9+
2110
# macOS
2211
.DS_Store
2312

24-
# Jekyll generated files
25-
.jekyll-cache
26-
.jekyll-metadata
27-
.sass-cache
28-
_asset_bundler_cache
29-
_site
30-
3113
# torrent stuff
3214
torrents

.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/.vitepress/theme"]
2+
path = docs/.vitepress/theme
3+
url = https://github.com/hacks-guide/vitepress-theme

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ https://3ds.hacks.guide/
77
## Running the site locally
88

99
This requires the following installed on your system:
10-
- ruby(-dev)
11-
- bundler
10+
- node.js
1211

1312
To test the website locally, clone the source code:
13+
1414
```sh
1515
git clone https://github.com/hacks-guide/Guide_3DS --recurse-submodules
1616
cd Guide_3DS
@@ -19,9 +19,8 @@ cd Guide_3DS
1919
Then simply run the following commands:
2020

2121
```sh
22-
bundle config set --local path vendor/bundle
23-
bundle install
24-
bundle exec jekyll serve
22+
npm ci
23+
npm run docs:dev
2524
```
2625

27-
The website should now be running on http://127.0.0.1:4000/.
26+
The website should now be running on http://127.0.0.1:5173/ (or a port shown on the terminal).

docs/.vitepress/config.mjs

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/*
2+
Copyright (C) 2024 Nintendo Homebrew
3+
SPDX-License-Identifier: MIT
4+
*/
5+
6+
import { fileURLToPath, URL } from 'node:url'
7+
import { defineConfig } from 'vitepress'
8+
9+
export default defineConfig({
10+
title: "3DS Hacks Guide",
11+
description: "A complete guide to 3DS custom firmware",
12+
vite: {
13+
resolve: {
14+
alias: [
15+
{
16+
find: /^.*\/VPHero\.vue$/,
17+
replacement: fileURLToPath(
18+
new URL('./theme/components/VPHero.vue', import.meta.url)
19+
)
20+
},
21+
{
22+
find: /^.*\/VPFooter\.vue$/,
23+
replacement: fileURLToPath(
24+
new URL('./theme/components/VPFooter.vue', import.meta.url)
25+
)
26+
}
27+
]
28+
}
29+
},
30+
})

docs/.vitepress/theme

Submodule theme added at 798ac68

0 commit comments

Comments
 (0)