These are the sources for the RailsGirls Workbook. It is build using HTML and CSS with the intention to make it easier to collaboratively edit its contents.
The simplest way to contribute small changes to the content of the workbook is to use GitHub's file editing feature. Just open the index.html.erb file and start editing by clicking the pen icon. After you're done editing, commit your changes and create a new pull request.
For larger changes, such as changes to the styling, it's recommended to fork and check out the repository. You must have Ruby and Git installed. Start by forking the workbook repository and cloning your fork using this command in your Terminal:
git clone https://github.com/<your-github-username>/workbookAfterwards, you can switch into the new directory and run the setup command, to install the necessary dependencies.
cd workbook
rake setupOpen the directory in your favorite editor and start changing the contents of the source directory. To preview your changes run rake preview and point your browser to http://localhost:4567/. After you've made some changes, simply reload the page to see the updated preview. For your convenience you may also install the LiveReload browser extension, which will automatically reload the page after you save a file.
Please bear in mind that this is only a simulation of what the finished PDF will look like. There might be slight differences between the preview and the generated PDF.
When you're done editing, commit your changes, push them to GitHub and create a new pull request.
The project is using Middleman to generate the workbook's HTML source. The generated HTML is sent to DocRaptor and transformed into a PDF. The process is automated using Travis CI which will push the generated PDF to Amazon S3.
- Create basic CSS framework to style pages