mirror of
https://github.com/hacks-guide/Guide_3DS.git
synced 2024-11-23 01:19:49 +00:00
Initialize VitePress
- Add theme submodule - Add initial configuration files - Override theme-default VPHero/VPFooter with custom theme version - Update README
This commit is contained in:
parent
afcba54398
commit
9446e2123a
26
.gitignore
vendored
26
.gitignore
vendored
@ -1,32 +1,14 @@
|
||||
# Vim
|
||||
*~
|
||||
*.sw[p_]
|
||||
|
||||
# Sublime Text
|
||||
*.sublime-project
|
||||
*.sublime-workspace
|
||||
|
||||
# Ruby Gem
|
||||
*.gem
|
||||
.bundle
|
||||
Gemfile.lock
|
||||
**/vendor/bundle
|
||||
|
||||
# Node.js and NPM
|
||||
node_modules
|
||||
npm-debug.log*
|
||||
package-lock.json
|
||||
codekit-config.json
|
||||
|
||||
# VitePress
|
||||
docs/.vitepress/cache
|
||||
docs/.vitepress/dist
|
||||
|
||||
# macOS
|
||||
.DS_Store
|
||||
|
||||
# Jekyll generated files
|
||||
.jekyll-cache
|
||||
.jekyll-metadata
|
||||
.sass-cache
|
||||
_asset_bundler_cache
|
||||
_site
|
||||
|
||||
# torrent stuff
|
||||
torrents
|
3
.gitmodules
vendored
Normal file
3
.gitmodules
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
[submodule "docs/.vitepress/theme"]
|
||||
path = docs/.vitepress/theme
|
||||
url = https://github.com/hacks-guide/vitepress-theme
|
11
README.md
11
README.md
@ -7,10 +7,10 @@ https://3ds.hacks.guide/
|
||||
## Running the site locally
|
||||
|
||||
This requires the following installed on your system:
|
||||
- ruby(-dev)
|
||||
- bundler
|
||||
- node.js
|
||||
|
||||
To test the website locally, clone the source code:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/hacks-guide/Guide_3DS --recurse-submodules
|
||||
cd Guide_3DS
|
||||
@ -19,9 +19,8 @@ cd Guide_3DS
|
||||
Then simply run the following commands:
|
||||
|
||||
```sh
|
||||
bundle config set --local path vendor/bundle
|
||||
bundle install
|
||||
bundle exec jekyll serve
|
||||
npm ci
|
||||
npm run docs:dev
|
||||
```
|
||||
|
||||
The website should now be running on http://127.0.0.1:4000/.
|
||||
The website should now be running on http://127.0.0.1:5173/ (or a port shown on the terminal).
|
||||
|
30
docs/.vitepress/config.mjs
Normal file
30
docs/.vitepress/config.mjs
Normal file
@ -0,0 +1,30 @@
|
||||
/*
|
||||
Copyright (C) 2024 Nintendo Homebrew
|
||||
SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
import { fileURLToPath, URL } from 'node:url'
|
||||
import { defineConfig } from 'vitepress'
|
||||
|
||||
export default defineConfig({
|
||||
title: "3DS Hacks Guide",
|
||||
description: "A complete guide to 3DS custom firmware",
|
||||
vite: {
|
||||
resolve: {
|
||||
alias: [
|
||||
{
|
||||
find: /^.*\/VPHero\.vue$/,
|
||||
replacement: fileURLToPath(
|
||||
new URL('./theme/components/VPHero.vue', import.meta.url)
|
||||
)
|
||||
},
|
||||
{
|
||||
find: /^.*\/VPFooter\.vue$/,
|
||||
replacement: fileURLToPath(
|
||||
new URL('./theme/components/VPFooter.vue', import.meta.url)
|
||||
)
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
})
|
1
docs/.vitepress/theme
Submodule
1
docs/.vitepress/theme
Submodule
@ -0,0 +1 @@
|
||||
Subproject commit 798ac6841c786e7b87f9119d27bed41679186406
|
2366
package-lock.json
generated
Normal file
2366
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
15
package.json
Normal file
15
package.json
Normal file
@ -0,0 +1,15 @@
|
||||
{
|
||||
"devDependencies": {
|
||||
"vitepress": "^1.3.4"
|
||||
},
|
||||
"scripts": {
|
||||
"docs:dev": "vitepress dev docs",
|
||||
"docs:build": "vitepress build docs",
|
||||
"docs:preview": "vitepress preview docs"
|
||||
},
|
||||
"dependencies": {
|
||||
"@fortawesome/fontawesome-svg-core": "^6.6.0",
|
||||
"@fortawesome/free-solid-svg-icons": "^6.6.0",
|
||||
"@fortawesome/vue-fontawesome": "^3.0.8"
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user