mirror of
https://github.com/torrentpier/torrentpier
synced 2025-08-21 13:54:02 -07:00
chore: update documentation setup and package configurations (#2018)
- Updated package.json for the documentation project to set the version to 1.0.0 and removed the unused 'docs' script. - Added package-lock.json for the documentation project to manage dependencies. - Revised README.md to streamline content and remove outdated build instructions, enhancing clarity on the documentation structure and deployment process. These changes improve the organization and clarity of the documentation setup, ensuring a smoother development and deployment experience.
This commit is contained in:
parent
0c8ea7974a
commit
a5d4de4a10
4 changed files with 17447 additions and 12 deletions
|
@ -11,22 +11,14 @@ npm start
|
|||
|
||||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||
|
||||
## Deployment
|
||||
|
||||
The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch. The deployment is handled by GitHub Actions.
|
||||
|
||||
## Structure
|
||||
|
||||
- `/docs` - Main documentation content
|
||||
- `/blog` - Development blog posts
|
||||
- `/docs` - Main documentation content
|
||||
- `/src` - Custom React components and pages
|
||||
- `/static` - Static assets like images
|
||||
|
||||
|
|
17444
docs/package-lock.json
generated
Normal file
17444
docs/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "docs",
|
||||
"version": "0.0.0",
|
||||
"version": "1.0.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"docusaurus": "docusaurus",
|
||||
|
|
|
@ -9,8 +9,7 @@
|
|||
"format": "prettier --write resources/",
|
||||
"format:check": "prettier --check resources/",
|
||||
"lint": "eslint . --fix",
|
||||
"types": "tsc --noEmit",
|
||||
"docs": "cd docs && npm run start"
|
||||
"types": "tsc --noEmit"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/js": "^9.19.0",
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue