Bridge Foundry Operations Guide
Welcome to the Operations Guide for Bridge Foundry, Inc., a US non-profit organization with a 501c3 designation.
For details about who runs our operations and writes this guide, see CONTRIBUTING
About mkdocs + operations.bridgefoundry.org
mkdocs to turn this git repository
into well-formatted HTML. You can run
mkdocs on your own computer to
preview the site. We use Travis-CI to generate the site when the
master branch updates; Travis-CI stores its logs
here. We use Firebase to
serve the website to the world; talk to Sarah for access to that.
To generate the nicely-formatted site on your own computer, open up a
terminal app and navigate to the folder with the operations
guide. Then, run the following commands. Note that if you get any
Command not found errors, you might need to run
virtualenv tmp/docs-virtualenv tmp/docs-virtualenv/bin/pip install mkdocs tmp/docs-virtualenv/bin/mkdocs serve
Now http://127.0.0.1:8000 should contain a live preview of the website.
Formatting with mkdocs
Here are the special things that mkdocs needs to display the markdown appropriately:
- New line between a paragraph and bullet points in order for bullet points to display
- Four spaces before a sub-bullet (rather than 2 spaces)
- Like this!