joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 01:36:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add Makefile For Easy Automated Testing Immediately After Building

Browse source 
New Makefile lets testers build the static HTML files and then run a few
automated tests to catch problems like missing files and links.  The
Makefile is not required; the site can still be built using just Jekyll.

This commit also fixes several image-related errors reported by `make
test` by adding the missing PNG images.
This commit is contained in:
David A. Harding 2014-05-17 01:00:16 -04:00
parent 7628cf1eef
commit 3a90000ed8
No known key found for this signature in database
GPG key ID: 4B29C30FF29EC4B7
6 changed files with 134 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -95,6 +95,30 @@ from _site/ to the root of your web server. If you have no web server, run
http://127.0.0.1:4000/. This server requires you to add a trailing ".html"
by hand in your browser address bar.
#### Building With Make
After you've installed Jekyll and the other depenencies, you can
optionally use GNU Make to automatically build the site and run several
tests. You will first need to install Make using your package manager;
for example:
sudo apt-get install make
Then in your local bitcoin.org repository, run one of the following
commands:
## To just build the site, the equivalent of: bundle exec jekyll build
make
## After you build the site, you can run all of the tests (may take awhile)
make test
## Or you can build the site and run some quick tests with one command:
make valid
## Or build the site and run all tests
make all
## Developer Documentation
Each part of the documentation can be found in the [_includes](https://github.com/bitcoin/bitcoin.org/tree/master/_includes)