Installation Guides @ roboticslab-uc3m
Currently hosted at http://robots.uc3m.es/gitbook-installation-guides
Please read the Developer Manual's Asking Questions section, and once you've succeded with its self-evaluation follow the recommendations by commenting publicly HERE if required
It is useful to serve on localhost
to modify the website and see changes locally.
Note: This specific repository is different, it uses a SUMMARY.md
that is auto-generated via scripts/admin/update-gitbook.sh. For general guides refer to install-gitbook.
-
Make sure you have installed gitbook-summary.
-
From the root of the project, run the following commands:
rm -r _book/ book sm -i CONTRIBUTING sed -i "s/\/SUMMARY.md/#\/SUMMARY.md/g" .gitignore gitbook serve # command builds and serves
-
You can now browse the site at the default location: http://127.0.0.1:4000
-
Recover
.gitignore
to its previous state:sed -i "s/#\/SUMMARY.md/\/SUMMARY.md/g" .gitignore
This project is managed as any project on GitHub. You may use Git or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the Gitbook (legacy) mechanism used:
-
Please do not upload the
_book/
folder. It is auto-generated locally, and the same should happen on the Gitbook (legacy) servers. For this repository, do not upload theSUMMARY.md
file. -
It is safe to
git push
to any upstream branch, just remember that what is onmaster
is what will be actually rendered as the website.