mirror of
https://github.com/rustdesk/doc.rustdesk.com.git
synced 2025-07-01 07:15:31 +00:00
Dependabot and README
This commit is contained in:
parent
83dde21c45
commit
8945ad1f74
22
.github/dependabot.yml
vendored
Normal file
22
.github/dependabot.yml
vendored
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: "github-actions"
|
||||||
|
directory: "/"
|
||||||
|
target-branch: "master"
|
||||||
|
schedule:
|
||||||
|
interval: "daily"
|
||||||
|
commit-message:
|
||||||
|
prefix: "👷 gh-actions"
|
||||||
|
labels:
|
||||||
|
- "dependencies"
|
||||||
|
- package-ecosystem: "gitsubmodule"
|
||||||
|
directory: "/"
|
||||||
|
target-branch: "master"
|
||||||
|
schedule:
|
||||||
|
interval: "daily"
|
||||||
|
allow:
|
||||||
|
- dependency-name: "themes/hextra"
|
||||||
|
commit-message:
|
||||||
|
prefix: "🎨 Theme"
|
||||||
|
labels:
|
||||||
|
- "dependencies"
|
10
.github/workflows/deploy.yml
vendored
10
.github/workflows/deploy.yml
vendored
@ -2,6 +2,8 @@ name: Deploy
|
|||||||
|
|
||||||
on: [workflow_dispatch]
|
on: [workflow_dispatch]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
jobs:
|
jobs:
|
||||||
deploy:
|
deploy:
|
||||||
name: Deploy
|
name: Deploy
|
||||||
@ -10,9 +12,12 @@ jobs:
|
|||||||
|
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
submodules: recursive
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Install Hugo
|
- name: Install Hugo
|
||||||
uses: peaceiris/actions-hugo@v2
|
uses: peaceiris/actions-hugo@v3
|
||||||
with:
|
with:
|
||||||
hugo-version: '0.147.8'
|
hugo-version: '0.147.8'
|
||||||
|
|
||||||
@ -28,9 +33,6 @@ jobs:
|
|||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: |
|
run: |
|
||||||
#sudo apt update
|
|
||||||
#sudo apt install -y git
|
|
||||||
git submodule update --init
|
|
||||||
hugo --minify
|
hugo --minify
|
||||||
cd public; tar czf x *
|
cd public; tar czf x *
|
||||||
scp x ${{ secrets.NAME }}@${{ secrets.HOST }}:/tmp/
|
scp x ${{ secrets.NAME }}@${{ secrets.HOST }}:/tmp/
|
||||||
|
43
README.md
43
README.md
@ -2,23 +2,40 @@
|
|||||||
|
|
||||||
[**Preview**](https://rustdesk.com/docs/)
|
[**Preview**](https://rustdesk.com/docs/)
|
||||||
|
|
||||||
Install [hugo](https://gohugo.io/getting-started/installing/)
|
## Preview and build at local
|
||||||
|
|
||||||
The clone this repo
|
1. Install [Hugo](https://gohugo.io/installation)
|
||||||
`git clone https://github.com/rustdesk/doc.rustdesk.com.git`
|
|
||||||
|
|
||||||
Change to this folder:
|
2. Clone the repo, if you want to submit changes, please [Fork](https://github.com/rustdesk/doc.rustdesk.com/fork) and clone your fork.
|
||||||
|
|
||||||
`cd docs.rustdesk.com`
|
```sh
|
||||||
|
git clone --recursive https://github.com/rustdesk/doc.rustdesk.com.git
|
||||||
Then run the following commands:
|
|
||||||
```
|
```
|
||||||
hugo new site quickstart
|
|
||||||
cd quickstart
|
3. Change to the folder:
|
||||||
git init
|
|
||||||
git clone https://github.com/matcornic/hugo-theme-learn themes/hugo-theme-learn
|
```sh
|
||||||
echo "theme = 'hugo-theme-learn'" >> hugo.toml
|
cd docs.rustdesk.com
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Start Hugo Server
|
||||||
|
|
||||||
|
```sh
|
||||||
hugo server
|
hugo server
|
||||||
```
|
```
|
||||||
|
|
||||||
Make any changes and then reupload.
|
If you found any bugs, stop the server and delete `public` folder and run again.
|
||||||
|
|
||||||
|
You could make changes and than push and create PR.
|
||||||
|
|
||||||
|
## Update branch/fork
|
||||||
|
|
||||||
|
Sync your fork at GitHub UI or create new branch that points to upstream.
|
||||||
|
|
||||||
|
Make sure you've checkout to right branch, and run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git pull --recurse-submodules
|
||||||
|
```
|
||||||
|
|
||||||
|
If you're cloned from here, just run the command.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user