diff --git a/README.md b/README.md index b451347..db8b9aa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,71 @@ -# MollyBlog -A simple and easy-to-use blog +
+ logo
+

Molly Blog

+

A simple and easy-to-use blog

+
+ +---- + +# What's this? + +This is a simple and easy-to-use personal blog system that I developed for my own use. +It is based on the Gin framework and uses object storage services as a carrier. + +I usually use Obsidian to write blogs, then synchronize the Markdown files to Tencent Cloud Object Storage (COS), +and then send an update request to MollyBlog, which will automatically pull the latest files from COS and render them into HTML. + +I will continue to add features I like in the future. If you have good ideas, welcome to raise issues! + + +# How to start? + +You only need to download the latest file that matches your system architecture from the release, +and unzip it as shown below: + +![](./docs/assets/molly-screenshot-001.png) + + +In the `_blog/src/about` , put your self-introduction file, which is named `index.md` by default. +Of course, you can also configure it in `config.yaml` + +Edit `config.yaml`, including website information, object storage configuration, friend link configuration, etc. + +Then run the program using the following command: + +```shell +chmod +x ./start.sh ./stop.sh ./molly +bash ./start.sh +``` + +![](./docs/assets/molly-screenshot-002.png) + + +If you want to update your blog, +please synchronize your blog to COS and use the following command to send an update request to Molly: + +```shell +curl --location --request POST 'http://[HOST]:[PORT]/update' \ +--header 'molly-secret: [SECRET_KEY]' +``` + +![](./docs/assets/molly-screenshot-003.png) + +If you modify the configuration file, please run `stop.sh` to stop the program, +and then re-run `start.sh` to start the program. + +```shell +bash ./stop.sh +bash ./start.sh +``` + + +# My Blog + +![](./docs/assets/molly-screenshot-004.png) + +![](./docs/assets/molly-screenshot-005.png) + +![](./docs/assets/molly-screenshot-006.png) + +![](./docs/assets/molly-screenshot-007.png) + diff --git a/docs/assets/molly-screenshot-001.png b/docs/assets/molly-screenshot-001.png new file mode 100644 index 0000000..ebb2eee Binary files /dev/null and b/docs/assets/molly-screenshot-001.png differ diff --git a/docs/assets/molly-screenshot-002.png b/docs/assets/molly-screenshot-002.png new file mode 100644 index 0000000..214a283 Binary files /dev/null and b/docs/assets/molly-screenshot-002.png differ diff --git a/docs/assets/molly-screenshot-003.png b/docs/assets/molly-screenshot-003.png new file mode 100644 index 0000000..2dfe566 Binary files /dev/null and b/docs/assets/molly-screenshot-003.png differ diff --git a/docs/assets/molly-screenshot-004.png b/docs/assets/molly-screenshot-004.png new file mode 100644 index 0000000..067e3ca Binary files /dev/null and b/docs/assets/molly-screenshot-004.png differ diff --git a/docs/assets/molly-screenshot-005.png b/docs/assets/molly-screenshot-005.png new file mode 100644 index 0000000..7c0d3a3 Binary files /dev/null and b/docs/assets/molly-screenshot-005.png differ diff --git a/docs/assets/molly-screenshot-006.png b/docs/assets/molly-screenshot-006.png new file mode 100644 index 0000000..983a211 Binary files /dev/null and b/docs/assets/molly-screenshot-006.png differ diff --git a/docs/assets/molly-screenshot-007.png b/docs/assets/molly-screenshot-007.png new file mode 100644 index 0000000..97c47d5 Binary files /dev/null and b/docs/assets/molly-screenshot-007.png differ diff --git a/docs/assets/molly.png b/docs/assets/molly.png new file mode 100644 index 0000000..b648dcc Binary files /dev/null and b/docs/assets/molly.png differ