X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README.md;h=68cf88888b75c8e7ba655f3910d0290141ee9a07;hb=f1ed8a89c9ade36f78966bf2feea445230ae58c7;hp=22bd080e2e5f749762dd9bb1ab06837750111f1b;hpb=8dda4023a5e675351ea43924f8e477af05eadccc;p=ardour-manual diff --git a/README.md b/README.md index 22bd080..68cf888 100644 --- a/README.md +++ b/README.md @@ -6,37 +6,12 @@ This is the project that generates the static ardour manual website available at 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. -`import.rb` (which gets the content from drupal) requires the `nokogiri` gem, but there are no other dependencies for the jekyll part (just the things required by jekyll itself). - ### Get the code git clone cd ardour-manual -### Run it locally - -This will generate the final html and start a local webserver. - - jekyll --server - -It should then be available at [localhost:4000](http://localhost:4000) - -### Import content from drupal - -This will pull the content from the [ardour drupal manual](http://ardour.org/manual/ardour3) and turn it into the format used in `_manual/`. You shouldn't really need to run this. - - ruby import.rb - -It's quite slow… :) - - -### Upload static site to live server - -Once the content has been built (using jekyll) you can put it live with this (assuming your ssh key has been put on the server): - - ./upload.sh - -## Strucuture of the content +## Structure of the content There are 2 different types of content: @@ -114,7 +89,21 @@ These are almost normal html, but extended with [Liquid templates](http://liquid - `{% tree %}` is what shows the manual structure in the left column - `{% children %}` shows the immediate list of children for a page -## manual.rb plugin + +## More Advanced Stuff + +You probably don't want or need to do any of this, but here are some +notes just in case you decide to anyway. + +### Run it locally + +This will generate the final html and start a local webserver. + + jekyll --server + +It should then be available at [localhost:4000](http://localhost:4000) + +### 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. @@ -130,4 +119,4 @@ The page format contained in the `_manual/` directory is different to the final - \ No newline at end of file +