From 602d92dd909a95d5dca24d10fb1b3cc46517ead1 Mon Sep 17 00:00:00 2001 From: Reckless_Satoshi Date: Tue, 13 Sep 2022 05:52:08 -0700 Subject: [PATCH] Add instructions to build and serve documentations locally --- docs/docker-compose.yml | 13 +++++++++++++ setup.md | 11 ++++++++++- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/docker-compose.yml diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml new file mode 100644 index 00000000..100e5943 --- /dev/null +++ b/docs/docker-compose.yml @@ -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 \ No newline at end of file diff --git a/setup.md b/setup.md index 91fe6314..1c71b657 100644 --- a/setup.md +++ b/setup.md @@ -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 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 -``` +``` \ No newline at end of file