Mirrors/tachiyomi-website
2
0
Fork 0
mirror of https://github.com/tachiyomiorg/website.git synced 2024-10-31 23:15:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove required docs: before npm script

Browse Source
This commit is contained in:
Soitora 2023-07-26 01:30:34 +02:00
parent c56a5184cd
commit 71ba3a80c9
No known key found for this signature in database
GPG Key ID: A6D711EB4F2CCD97
4 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/deploy.yml vendored
View File

@ -39,7 +39,7 @@ jobs:
cache-dependency-path: "**/package-lock.json" cache-dependency-path: "**/package-lock.json"
- name: Install and build - name: Install and build
run: npm ci && npm run docs:build run: npm ci && npm run build
- name: Configure pages - name: Configure pages
uses: actions/configure-pages@v2 uses: actions/configure-pages@v2

25
CONTRIBUTING.md
View File

@ -10,7 +10,7 @@ Before submitting your contribution, please make sure to take a moment and read
You will need [Node.js](http://nodejs.org) **version 16+**, and [npm](https://docs.npmjs.com/try-the-latest-stable-version-of-npm) **version 8+**. You will need [Node.js](http://nodejs.org) **version 16+**, and [npm](https://docs.npmjs.com/try-the-latest-stable-version-of-npm) **version 8+**.
After cloning the repo, run: After cloning the repo and entering the the directory, go to the `/website` folder and run:
``` bash ``` bash
# Installs any dependencies needed. # Installs any dependencies needed.
@ -21,32 +21,33 @@ To run the project now, run:
``` bash ``` bash
# This command start a local server you can access and edit live. # This command start a local server you can access and edit live.
$ npm run docs:dev $ npm run dev
``` ```
### Commonly used NPM scripts ### Commonly used NPM scripts
``` bash ``` bash
# This command will generate a static site inside a dist directory in your project. # This command will generate a static site inside a dist directory in your project.
$ npm run docs:build $ npm run build
# Run this command to preview the built files in a local server. # Run this command to preview the built files in a local server.
$ npm run docs:preview $ npm run preview
``` ```
**Please make sure to have `npm run docs:build` pass successfully before submitting a PR.** Although the same tests will be run against your PR on the CI server, it is better to have it working locally. **Please make sure to have `npm run build` pass successfully before submitting a PR.** Although the same tests will be run against your PR on the CI server, it is better to have it working locally.
It is also recommended you lint your files before the PR. It is also recommended you lint your files before the PR.
## Project Structure ## Project Structure
- **`src`**: contains all the markdown files used for the website. - **`website`**: contains all the website related files.
- **`.vitepress`**: - **`src`**: contains all the markdown files used for the website.
- **[`dist`](https://vitepress.dev/guide/deploy)**: contains built files for distribution. Note this directory is only updated when a release happens or when you run the build command. Changes to this folder will not carry over with Git. - **`.vitepress`**:
- **`theme`**: contains custom theme files. - **[`dist`](https://vitepress.dev/guide/deploy)**: contains built files for distribution. Note this directory is only updated when a release happens or when you run the build command. Changes to this folder will not carry over with Git.
- `config.ts`: main configuration file for VitePress. - **`theme`**: contains custom theme files.
- **`public`**: files to be exposed publicly without any processing. - `config.ts`: main configuration file for VitePress.
- `package.json`: contains information about which plugins are installed in the project. - **`public`**: files to be exposed publicly without any processing.
- `package.json`: contains information about which plugins are installed in the project.
## Images and Videos guidelines ## Images and Videos guidelines

2
netlify.toml
View File

@ -4,4 +4,4 @@
[build] [build]
base = "website" base = "website"
publish = "src/.vitepress/dist" publish = "src/.vitepress/dist"
command = "npm run docs:build" command = "npm run build"

6
website/package.json
View File

@ -12,9 +12,9 @@
"url": "https://github.com/tachiyomiorg/website/issues" "url": "https://github.com/tachiyomiorg/website/issues"
}, },
"scripts": { "scripts": {
"docs:dev": "vitepress dev src", "dev": "vitepress dev src",
"docs:build": "npm run lint && vitepress build src", "build": "npm run lint && vitepress build src",
"docs:preview": "vitepress preview src", "preview": "vitepress preview src",
"lint": "npm run lint:es && npm run lint:prettier && npm run lint:mdl && npm run lint:style", "lint": "npm run lint:es && npm run lint:prettier && npm run lint:mdl && npm run lint:style",
"lint:fix": "npm run lint:es:fix && npm run lint:prettier:fix && npm run lint:style:fix", "lint:fix": "npm run lint:es:fix && npm run lint:prettier:fix && npm run lint:style:fix",
"lint:es": "eslint . --ext .vue,.js,.ts,.jsx,.tsx", "lint:es": "eslint . --ext .vue,.js,.ts,.jsx,.tsx",