Add instructions to build and serve documentations locally

This commit is contained in:
Reckless_Satoshi 2022-09-13 05:52:08 -07:00
parent 45d14f2249
commit 602d92dd90
No known key found for this signature in database
GPG Key ID: 9C4585B561315571
2 changed files with 23 additions and 1 deletions

13
docs/docker-compose.yml Normal file
View File

@ -0,0 +1,13 @@
version: '3.9'
services:
jekyll:
image: jekyll/jekyll:4.0
container_name: pages
restart: always
volumes:
- .:/usr/src/docs
command: bash -c "cd /usr/src/docs/
&& bundle install
&& bundle exec jekyll serve --force_polling -H 0.0.0.0 -P 4000"
ports:
- 4000:4000

View File

@ -38,6 +38,15 @@ If you need to edit CSS or other static files in `/frontend/static`, simply add
i.e: index.css
Make "{robosats-site}/static/css/index.css" redirect to "127.0.0.1:8080/css/index.css"
# Documentation Jekyll Site Only
Simply run the de docker-compose within /docs/ in order to watch files, build and serve the Learn RoboSats site locally.
```bash
cd docs
docker-compose up
# press Ctrl+C to exit the process
```
Then visit `127.0.0.1:4000` on your browser. Once you save changes on a file it will take around 10s for the site to update (press <Ctrl+Shift+R> to force-refresh your browser).
# Full Stack Development
## The Easy Way: Docker-compose (-dev containers running on testnet)
@ -312,4 +321,4 @@ Then launch it with
```
systemctl start clean_orders
systemctl enable clean_orders
```
```