adafruit-mirror/circuitpython-org
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: Explain how to test locally

Browse source
This commit is contained in:
Jeff Epler 2019-09-17 20:36:36 -05:00
parent 57cec5a8ae
commit ea4f0d05f5
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -9,3 +9,14 @@ and a larger image (700 px width) in each respective directory (assets/images/bo
and process them in something like https://squoosh.app/ to reduce file size. If
you only have one image, place it in the 'original' folder.
3. Create a pull request with the file changes.
**To test your changes locally:**
1. You need "ruby" and "ruby-bundler" installed locally. These instructions
were tested with ruby 2.5 and ruby-bundler 1.17.3 on a Debian Stretch system.
2. As needed, `git submodule update --init --recursive` to fetch the submodules
3. One time, run `bundle install --path vendor/bundle`
4. Run `bundle exec jekyll serve` to generate the site locally
5. Visit the displayed "server address"
6. After most local edits, the content will be updated. You will need to
reload (ctrl-r or F5) your browser