hacks-guide/Guide_Vita
1
0
Fork 0
mirror of https://github.com/hacks-guide/Guide_Vita.git synced 2025-02-19 18:40:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Switch to new theme and update VuePress to beta49 (#161)

Browse Source 
* Switch to new theme and update VuePress to beta49

Non-breaking changes in the guide:
- URLs in the get-started version table now explicitly include `.html`
  as otherwise it doesn't work under Vite. (It probably works under
  GitHub Pages, but it's better for it to work everywhere instead.)

Breaking changes in the guide:
- The front page button is nixed and replaced with a link to
  get-started at end of page

* Kang publish script from dsi.cfw.guide

The VuePress 2.0.0-b49 changes were only tested with npm. It is unknown
whether yarn will actually work with the changes.

dsi.cfw.guide already uses npm for this, so let's just use the script
from there as it is known to work.

This file was taken from the following snapshot:
66d1089257/.github/workflows/publish.yml

* Document website testing process in README

* fix hero image and add get started button

* update theme

---------

Co-authored-by: emiyl <me@emiyl.com>
This commit is contained in:
lifehackerhansol 2023-04-06 12:14:42 -07:00 committed by GitHub
parent 5713d208f3
commit d0d958cf9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 78 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
.github/workflows/publish.yml vendored
View File

@ -1,47 +1,38 @@
name: docs
name: Deploy site
on:
# trigger deployment on every push to main branch
push:
branches: [ main, master ]
# trigger deployment manually
branches: [ master ]
paths:
- docs/**
- .github/workflows/publish.yml
- package.json
workflow_dispatch:
jobs:
docs:
doc-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
# fetch all commits to get last updated time or other git log info
fetch-depth: 0
persist-credentials: false
submodules: recursive
- name: Setup Node.js
uses: actions/setup-node@v1
- uses: actions/setup-node@v3
with:
# choose node.js version to use
node-version: '14'
node-version: 14
# install dependencies if the cache did not hit
- name: Install dependencies
if: steps.yarn-cache.outputs.cache-hit != 'true'
run: yarn --frozen-lockfile
run: npm install
# run build script
- name: Build VuePress site
run: yarn docs:build
- name: Run VuePress
# Build the site using VuePress
run: npm run docs:build
# please check out the docs of the workflow for more details
# @see https://github.com/crazy-max/ghaction-github-pages
- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v2
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4.4.1
with:
# deploy to gh-pages branch
target_branch: gh-pages
# deploy the default output dir of VuePress
build_dir: docs/.vuepress/dist
env:
# @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages # The branch the action should deploy to.
folder: docs/.vuepress/dist # The folder the action should deploy.
clean: true # Automatically remove deleted files from the deploy branch

2
.gitmodules vendored
View File

@ -1,3 +1,3 @@
[submodule "docs/.vuepress/vuepress-theme"]
path = docs/.vuepress/vuepress-theme
url = https://github.com/cfw-guide/vuepress-theme
url = https://github.com/emiyl/emiyl-theme

19
README.md
View File

@ -1 +1,20 @@
# vita.hacks.guide
The complete guide to modding your PlayStation Vita.
https://vita.hacks.guide
## Running the site locally
This requires the following installed to your system:
- node.js, v14 or later
- its respective npm
To test the website locally, simply run the following commands:
```
npm install
```
to install all packages required by the website (VuePress v2 and plugins), then
```
npm run docs:dev
```
to build the Markdown files into HTML and start a testing webserver on http://127.0.0.1:8080.

20
docs/.vuepress/config.js
View File

@ -1,5 +1,7 @@
const config = require("./configs");
const path = require("path");
const { localTheme } = require('./vuepress-theme')
const { registerComponentsPlugin } = require('@vuepress/plugin-register-components')
module.exports = {
locales: {
@ -15,14 +17,13 @@ module.exports = {
}
],
[
'@vuepress/register-components',
{
componentsDir: path.resolve(__dirname, './components')
}
registerComponentsPlugin({
componentsDir: path.resolve(__dirname, './components')
})
],
],
themeConfig: {
theme: localTheme({
repo: 'hacks-guide/Guide_Vita',
docsBranch: "master",
docsDir: "docs",
@ -34,7 +35,7 @@ module.exports = {
locales: {
'/': config.en_US.themeConfig
},
},
}),
head: [
[ 'link', { rel: 'apple-touch-icon', sizes: "180x180", href: '/assets/images/apple-touch-icon.png?v=PYEmwKvQAx' } ],
@ -55,10 +56,5 @@ module.exports = {
[ 'script', { type: 'text/javascript', src: '//cdn.thisiswaldo.com/static/js/5303.js' } ],
[ 'script', { src: 'https://www.googletagmanager.com/gtag/js?id=UA-152619365-1'} ],
[ 'script', {}, 'function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","UA-152619365-1");' ],
],
theme: path.resolve(__dirname, './vuepress-theme'),
templateDev: path.join(__dirname, 'templates', 'index.dev.html'),
templateSSR: path.join(__dirname, 'templates', 'index.ssr.html'),
]
};

34
docs/.vuepress/templates/index.dev.html
View File

@ -1,34 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script>
<style>
:root {
--c-bg: #fff;
}
html.dark {
--c-bg: #22272e;
}
html, body {
background-color: var(--c-bg);
}
</style>
<script>
(function() {
const userMode = localStorage.getItem('vuepress-color-scheme');
const systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;
if (userMode === 'dark' || (userMode !== 'light' && systemDarkMode)) {
document.documentElement.classList.toggle('dark', true);
}
})();
</script>
</head>
<body>
<div id="app"></div>
</body>
</html>

38
docs/.vuepress/templates/index.ssr.html
View File

@ -1,38 +0,0 @@
<!DOCTYPE html>
<html lang="{{ lang }}">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script>
<style>
:root {
--c-bg: #fff;
}
html.dark {
--c-bg: #22272e;
}
html, body {
background-color: var(--c-bg);
}
</style>
<script>
(function() {
const userMode = localStorage.getItem('vuepress-color-scheme');
const systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;
if (userMode === 'dark' || (userMode !== 'light' && systemDarkMode)) {
document.documentElement.classList.toggle('dark', true);
}
})();
</script>
<!--vuepress-ssr-head-->
<!--vuepress-ssr-resources-->
<!--vuepress-ssr-styles-->
</head>
<body>
<div id="app"><!--vuepress-ssr-app--></div>
<!--vuepress-ssr-scripts-->
</body>
</html>

2
docs/.vuepress/vuepress-theme

@ -1 +1 @@
Subproject commit 3de1de984c4b0c0a5c8c37a8859962999aa54591
Subproject commit 03861e249c3af67e4e9f01d4ecae545963055476

12
docs/get-started.md
View File

@ -36,32 +36,32 @@ Before starting, Windows users should enable the option to show file extensions
<tr>
<td style="text-align: center; font-weight: bold;">1.03</td>
<td style="text-align: center; font-weight: bold;">3.59</td>
<td style="text-align: center; font-weight: bold;"><a href="updating-firmware-(3.60)">Updating Firmware (3.60)</a></td>
<td style="text-align: center; font-weight: bold;"><a href="updating-firmware-(3.60).html">Updating Firmware (3.60)</a></td>
</tr>
<tr>
<td style="text-align: center; font-weight: bold;">3.60</td>
<td style="text-align: center; font-weight: bold;">3.60</td>
<td style="text-align: center; font-weight: bold;"><a href="installing-henkaku">Installing HENkaku</a></td>
<td style="text-align: center; font-weight: bold;"><a href="installing-henkaku.html">Installing HENkaku</a></td>
</tr>
<tr>
<td style="text-align: center; font-weight: bold;">3.61</td>
<td style="text-align: center; font-weight: bold;">3.63</td>
<td style="text-align: center; font-weight: bold;"><a href="updating-firmware-(3.74)">Updating Firmware (3.74)</a></td>
<td style="text-align: center; font-weight: bold;"><a href="updating-firmware-(3.74).html">Updating Firmware (3.74)</a></td>
</tr>
<tr>
<td style="text-align: center; font-weight: bold;">3.65</td>
<td style="text-align: center; font-weight: bold;">3.65</td>
<td style="text-align: center; font-weight: bold;"><a href="using-henlo">Using HENlo</a></td>
<td style="text-align: center; font-weight: bold;"><a href="using-henlo.html">Using HENlo</a></td>
</tr>
<tr>
<td style="text-align: center; font-weight: bold;">3.67</td>
<td style="text-align: center; font-weight: bold;">3.73</td>
<td style="text-align: center; font-weight: bold;"><a href="updating-firmware-(3.74)">Updating Firmware (3.74)</a></td>
<td style="text-align: center; font-weight: bold;"><a href="updating-firmware-(3.74).html">Updating Firmware (3.74)</a></td>
</tr>
<tr>
<td style="text-align: center; font-weight: bold;">3.74</td>
<td style="text-align: center; font-weight: bold;">3.74</td>
<td style="text-align: center; font-weight: bold;"><a href="using-henlo">Using HENlo</a></td>
<td style="text-align: center; font-weight: bold;"><a href="using-henlo.html">Using HENlo</a></td>
</tr>
</tbody>
</table>

22
docs/index.md
View File

@ -2,14 +2,12 @@
title: "Home"
description: "A complete guide to PS Vita (TV) custom firmware, from stock to Ensō."
home: true
header:
overlay_title: PS Vita (TV) Hacks Guide
overlay_excerpt: A complete guide to PS Vita (TV) custom firmware, from stock to Ensō.
overlay_image: /assets/images/home-page-feature.jpg
overlay_filter: 0.5
overlay_color: 1a1d24
cta_label: "Get Started"
cta_url: get-started
heroImage: /assets/images/home-page-feature.jpg
heroFilter: 0.5
actions:
- text: Get Started
link: get-started
type: secondary
---
::: tip
@ -71,4 +69,10 @@ Ensō is available on all devices with firmware version 3.65 or below, while hig
+ This guide will work on all PS Vita, PS Vita Slim, and PS TV devices in all regions on firmwares from 1.03 to 3.74
+ If everything goes according to plan, you will lose no data and end up with everything that you started with (games, PSN Account, saves, etc. will be preserved).
+ **Keep your device plugged in and charged throughout the entire process to avoid data loss or damage from an unexpected power-off!**
+ The PS Vita 2000 and PS TV models are essentially identical to the original PS Vita 1000 in terms of software. All steps which say "PS Vita" also apply to other models unless otherwise specified.
+ The PS Vita 2000 and PS TV models are essentially identical to the original PS Vita 1000 in terms of software. All steps which say "PS Vita" also apply to other models unless otherwise specified.
::: tip
Continue to [Get Started](get-started)
:::

25
package.json
View File

@ -1,17 +1,12 @@
{
"dependencies": {
"yarn": "^1.22.17"
},
"devDependencies": {
"@vue/component-compiler-utils": "^3.3.0",
"@vuepress/plugin-register-components": "2.0.0-beta.26",
"@vuepress/plugin-search": "2.0.0-beta.26",
"@vuepress/shared-utils": "^1.8.2",
"markdown-it-include": "^2.0.0",
"vuepress": "2.0.0-beta.26"
},
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
"devDependencies": {
"@vuepress/plugin-register-components": "2.0.0-beta.49",
"@vuepress/plugin-search": "2.0.0-beta.49",
"markdown-it-container": "^3.0.0",
"vuepress": "2.0.0-beta.49"
},
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}