mirror of
https://github.com/Reckless-Satoshi/robosats.git
synced 2024-09-11 11:55:26 +03:00
Add instructions to build and serve documentations locally
This commit is contained in:
parent
45d14f2249
commit
602d92dd90
13
docs/docker-compose.yml
Normal file
13
docs/docker-compose.yml
Normal 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
|
11
setup.md
11
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 <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
|
||||
```
|
||||
```
|
Loading…
Reference in New Issue
Block a user