Skip to content

Commit 0f6b6d1

Browse files
committed
feat:#1 添加配置说明
1 parent c63eab6 commit 0f6b6d1

File tree

3 files changed

+44
-2
lines changed

3 files changed

+44
-2
lines changed

.env.example

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# setting for Siyuan-Note
2+
SIYUAN_API_URL=
3+
SIYUAN_AUTH_TOKEN=
4+
5+
# setting for WordPress
6+
WORDPRESS_API_URL=https://wordpress-host/xmlrpc.php
7+
WORDPRESS_USERNAME=
8+
WORDPRESS_PASSWORD=
9+
10+
# set wordpress as default
11+
DEFAULT_TYPE=wordpress

README.md

+31-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ See also:[https://github.com/element-plus/element-plus-nuxt-starter/issues/46](h
88
## Install
99
```bash
1010
dnf install npm
11+
# apt install nom
12+
npm i -g n
13+
sudo n stable
14+
1115
npm i -g yarn
1216
npm i -g vercel
1317
npm i -g pm2
@@ -17,7 +21,31 @@ npm i -g pm2
1721
yarn
1822
```
1923

20-
## dev
24+
## Set up environment variables
25+
26+
Copy the .env.example file in this directory to .env (which will be ignored by Git):
27+
28+
```bash
29+
cp .env.example .env
30+
```
31+
32+
and change the config, the file maybe like this:
33+
34+
```properties
35+
# setting for Siyuan-Note
36+
SIYUAN_API_URL=
37+
SIYUAN_AUTH_TOKEN=
38+
39+
# setting for WordPress
40+
WORDPRESS_API_URL=https://wordpress-host/xmlrpc.php
41+
WORDPRESS_USERNAME=
42+
WORDPRESS_PASSWORD=
43+
44+
# set wordpress as default
45+
DEFAULT_TYPE=wordpress
46+
```
47+
48+
## Dev
2149

2250
```bash
2351
yarn dev
@@ -29,7 +57,8 @@ or
2957
yarn vdev
3058
```
3159

32-
## deploy
60+
## Deploy
61+
3362
```bash
3463
pm2 start pm2.json
3564
```

components/default/Footer.vue

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
<!-- 备案信息 -->
1212
<div class="page copyright">
1313
&copy; 2011-{{ getNowYear() }} <a href="https://terwer.space" target="_blank">Terwer</a> All Rights Reseaved.
14+
<a href="https://github.com/terwer/jvue-front" target="_blank">Github</a>.
15+
<a>暗黑模式</a>
1416
</div>
1517
</footer>
1618
</template>

0 commit comments

Comments
 (0)