ardour
/
manual
13
0
Fork 0
Code Pull Requests Releases Activity

Remove unnecessary white space and update instructions for hosting and using the manual locally.

This commit is contained in:
StillLearnin 2015-06-07 20:19:35 -04:00
parent 23da318496
commit 85e5062efb
1 changed files with 44 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -4,11 +4,11 @@
This is the project that generates the static ardour manual website available at [manual.ardour.org](http://manual.ardour.org).
The site is built using ruby (I use 1.9[.3]) and [Jekyll](https://github.com/mojombo/jekyll) (a ruby gem). You should be able to just install ruby and then `gem install jekyll` to get it up and running.
The site is built using ruby (I use 1.9[.3]) and [liquid](http://liquidmarkup.org/), a ruby gem.
### Get the code
git clone <repo-url>
git clone <repo-url> ardour-manual
cd ardour-manual
## Structure of the content
@ -97,15 +97,45 @@ notes just in case you decide to anyway.
### Run it locally
This will generate the final html and start a local webserver.
You may want the manual available on a machine that doesn't have constant
internet access. You will need `git`, `ruby`, and the ruby gem `liquid` installed.
jekyll serve
1. Download code and build manual
It should then be available at [localhost:4000](http://localhost:4000)
```
git clone <repo-url> ardour-manual
cd ardour-manual
cp -r source _site
ruby ./build.rb
chmod -R a+rx _site
```
2. open `ardour-manual/_site/index.html` in your favorite web browser
If this page doesn't open and function correctly, follow these optional steps to serve up the page with nginx.
3. Install [nginx](http://wiki.nginx.org/Install)
4. Configure nginx server block in `/etc/nginx/sites-available/default`
```
server {
listen 80;
server_name localhost;
root ...path_to_.../ardour-manual/_site;
index index.html;
}
```
5. Restart nginx server
service nginx restart
6. The manual will now be available at http://localhost
### manual.rb plugin
Much of the functionality comes from `_plugins/manual.rb` - it takes the _manual format_ (contained in `_manual/`) and mushes it around a bit into a tmp directory before letting jekyll do it's normal thing. It's all hooked into the jekyll command so no special actions are required.
Much of the functionality comes from `_plugins/manual.rb` - it takes the _manual format_ (contained in `_manual/`) and mushes it around a bit into a tmp directory.
This is to enable the directory tree to be understood, child page lists to be constructed, clean URLs, and the correct ordering of pages maintained.