Mercurial > web-octave

comparison README.md @ 182:7a664b44fd8d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use Bundler for consistent development environment with Jekyll. * README.md: Update documentation for new development workflow * Makefile: Remove custom tool version checks. * _config.yml: Adapt to Bundler workflow. * Gemfile: Document requirements for Bundler. * Gemfile.lock: Document currently used tool versions for Bundler.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Wed, 20 May 2020 14:05:39 +0900
parents 3ecaed4b95e8
children ff5b4e46fe3d
comparison
equal deleted inserted replaced
181:0fe4f2163a9c 182:7a664b44fd8d
37 37
38 38
39 39
40 ### Building requisites 40 ### Building requisites
41 41
42 To build the static website, you need to install [Jekyll][6] and a few more 42 To build the static website, you need to install [Jekyll][6] and [Bundler][7].
43 tools from [Rubygems][7]. Just type 43 For Debian/Ubuntu please perform the following setup fist. For other Linux
44 distributions this command might change.
44 45
45 gem install jekyll pygments.rb 46 sudo apt-get install ruby-full build-essential zlib1g-dev
46 47
47 A small prerequisite check is performed, by Typing 48 Then install the required tools
48 49
49 make check_prerequisites 50 gem install jekyll bundler
51
52 From now on, almost everything is handled by Bundler. Install all required
53 dependencies for the static Octave website by running
54
55 bundle install
56
57 from within the checked-out [hg development repository][2].
50 58
51 For the responsive webpages, we internally use the [Foundation 5][8] 59 For the responsive webpages, we internally use the [Foundation 5][8]
52 framework. All necessary files are already included inside the 60 framework. All necessary files are already included inside the
53 [hg development repository][2]. 61 [hg development repository][2].
54 62
55 [6]: https://jekyllrb.com/ 63 [6]: https://jekyllrb.com/
56 [7]: https://rubygems.org/ 64 [7]: https://bundler.io/
57 [8]: https://foundation.zurb.com/sites/docs/v/5.5.3/ 65 [8]: https://foundation.zurb.com/sites/docs/v/5.5.3/
58 66
59 67
60 68
61 ### Building the static website locally 69 ### Building the static website locally
62 70
63 All relevant information for Jekyll to build the static website is located 71 All relevant information for Jekyll and Bundler to build the static website are
64 in the file `_config.yml`. 72 located in the files `_config.yml`, `Gemfile`, and `Gemfile.lock`.
65 Typing 73 Typing
66 74
67 jekyll build 75 bundle exec jekyll build
68 76
69 from the repositories root directory will build a complete static website 77 from the repositories root directory will build a complete static website
70 into the subdirectory `_site` using this information (this directory is 78 into the subdirectory `_site` using this information (this directory is
71 ignored by Mercurial and will be created on first build). 79 ignored by Mercurial and will be created on first build).
72 80
73 Especially for development, it is beneficial to watch the changes locally 81 Especially for development, it is beneficial to watch the changes locally
74 before pushing any changes. 82 before pushing any changes. Jekyll provides a local webserver by typing
75 Jekyll provides a local webserver by typing
76 83
77 jekyll serve 84 bundle exec jekyll serve
78 85
79 and rebuilds the whole static website automatically, as it monitors any 86 and rebuilds the whole static website automatically, as it monitors any
80 file changes. 87 file changes.
81
82 To build the test page, that can be deployed at some subdirectory, e.g.
83 `https://www.octave.org/new`, use
84
85 jekyll build --config _config.yml,_config_test.yml
86 88
87 89
88 90
89 ### Add a new RSS post 91 ### Add a new RSS post
90 92