Skip to content

Commit e176490

Browse files
committed
chore: extend REQUIREMENTS.md with general instructions about adding new posts etc
1 parent 46b04e4 commit e176490

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

REQUIREMENTS.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,29 @@ are listed below.
88
You need so install RubyGems using `gem install`.
99

1010
The homepage itself will be built in `_site/`. The contents of `_site/` is exactly
11-
the same as what is shown at `igraph.org`. Instead of running Jekyll manually,
12-
you should call:
11+
the same as what is shown at `igraph.org`.
1312

14-
* `make core` to rebuild the core parts of the homepage.
13+
If you simply want to add new blog posts, change the layout of the site or do
14+
anything that does not involve messing around with igraph's source code (like
15+
generating docs for a new version), the only thing that you need to know is
16+
that you can edit the Jekyll pages locally and then run the following command
17+
to preview your changes after a clean checkout:
1518

16-
* `make c` to rebuild the parts related to the C library.
19+
`bundle install && bundle exec jekyll serve`
1720

18-
* `make python` to rebuild the parts related to the Python interface.
21+
where `bundle install` takes care of installing Jekyll locally.
1922

20-
* `make r` to rebuild the parts related to the R interface.
23+
If you need to modify the parts of the homepage that are related to the
24+
_generated_ documentation, there are a few useful `make` commands that you
25+
should know about:
26+
27+
* `make core` rebuilds the core parts of the homepage.
28+
29+
* `make c` rebuilds the parts related to the C library.
30+
31+
* `make python` rebuilds the parts related to the Python interface.
32+
33+
* `make r` rebuilds the parts related to the R interface.
2134

2235
When you are satisfied with your changes, commit everything (excluding the
2336
generated HTML files of the homepage in `_site/`) and push it to Github. Github

0 commit comments

Comments
 (0)