Mercurial > web-octave

annotate README.md @ 31:beb4387a8937

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Create README.md
author Alex Krolick <whokilledtheelectricmonk@gmail.com>
date Sun, 27 Dec 2015 14:44:46 -0900
parents
children 48f5e0fda5a8 e8fc61e077fc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
1 # octave-web
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
2 Proposed update of [octave.org](http://www.octave.org).
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
3
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
4 ## Developing
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
5 - Install Jekyll from Rubygems
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
6
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
7 `gem install jekyll`
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
8
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
9 - Compile the assets into `_site` (this directory is ignored by revision control and will be created on first build)
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
10
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
11 `jekyll build`
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
12
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
13 - Serve the site
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
14
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
15 `jekyll serve --watch`
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
16
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
17 ## Configuring
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
18 See [_config.yml](_config.yml). In particular, `baseurl` will need to be adjusted to match the path of the subdirectory where the site will be hosted, e.g., for `gnu.org/octave` use `/octave`. Currently `baseurl` is set to the repository name in order to work with the Github Pages' build service.
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
19
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
20 ## Deploying
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
21 - Configure paths as needed in `_config.yml`
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
22 - Build the static site
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
23
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
24 `jekyll build`
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
25
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
26 - Copy the static assets from `_site` to a server.