From 203716ea508de2205cf9d938e3fb5cad99a8ac40 Mon Sep 17 00:00:00 2001 From: Christopher Gervais Date: Fri, 3 Mar 2017 13:27:51 -0500 Subject: [PATCH] Clarify some docs and improve code highlighting. --- docs/_css/term.css | 16 +++++++--------- docs/documentation.md | 36 ++++++++++++++++-------------------- docs/index.md | 20 ++++++-------------- docs/install.md | 9 +++++---- mkdocs.yml | 4 ++++ 5 files changed, 38 insertions(+), 47 deletions(-) diff --git a/docs/_css/term.css b/docs/_css/term.css index 7d602db6b..23802723a 100644 --- a/docs/_css/term.css +++ b/docs/_css/term.css @@ -1,17 +1,15 @@ -pre code.console { +pre.codehilite > code, +div.codehilite > pre { background-color: black; color: #808080; padding: 1em; - border-radius: 5px; + border-radius: 3px; font-size: 110%; + font-weight: bold; overflow: auto; } -span.hljs-built_in, -span.hljs-comment, -span.hljs-keyword, -span.hljs-variable { - color: #808080; - font-weight: normal; - font-style: normal; +pre.codehilite > code.language-console > span, +div.codehilite > pre > span[style*="color: #AA22FF"] { + color: #808080 !important; } diff --git a/docs/documentation.md b/docs/documentation.md index 344db6721..3145b07f8 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -3,30 +3,26 @@ Documentation The LibreTime documentation site is generated with [mkdocs](http://www.mkdocs.org/). To get started contributing to this project, fork it on Github. Then install mkdocs and clone this repo locally: -```console -$ sudo brew install python # For OSX users -$ sudo aptitude install python-pip # For Debian/Ubuntu users -$ sudo pip install mkdocs -$ git clone https://github.com/libretime/libretime -$ cd libretime -$ git remote add sandbox https://github.com//libretime # URL for your fork -$ mkdocs build --clean -$ mkdocs serve -``` + :::console + $ sudo brew install python # For OSX users + $ sudo aptitude install python-pip # For Debian/Ubuntu users + $ sudo pip install mkdocs + $ git clone https://github.com/libretime/libretime + $ cd libretime + $ git remote add sandbox https://github.com//libretime # URL for your fork + $ mkdocs build --clean + $ mkdocs serve Your local LibreTime docs site should now be available for browsing: [http://localhost:8888/](http://localhost:8888/). When you find a typo, an error, unclear or missing explanations or instructions, open a new terminal and start editing. Your changes should be reflected automatically on the local server. Find the page you’d like to edit; everything is in the docs/ directory. Make your changes, commit and push them, and start a pull request: -```console -$ git checkout -b fix_typo -$ vi docs/index.md # Add/edit/remove whatever you see fit. Be bold! -$ mkdocs build --clean; mkdocs serve # Go check your changes. We’ll wait... -$ git diff # Make sure there aren’t any unintended changes. -diff --git a/docs/index.md b/docs/index.md -... -$ git commit -am”Fixed typo.” # Useful commit message are a good habit. -$ git push sandbox fix_typo -``` + :::console + $ git checkout -b fix_typo + $ vi docs/index.md # Add/edit/remove whatever you see fit. Be bold! + $ mkdocs build --clean; mkdocs serve # Go check your changes. We’ll wait... + $ git diff # Make sure there aren’t any unintended changes. + $ git commit -am”Fixed typo.” # Useful commit message are a good habit. + $ git push sandbox fix_typo Visit your fork on Github and start a PR. diff --git a/docs/index.md b/docs/index.md index 14badee97..dee947f61 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,19 +15,11 @@ LibreTime is a fork of AirTime due to stalled development of the FLOSS version. Getting Started --------------- -The easiest way to check out LibreTime for yourself is to run a local instance in a virtual machine: +The easiest way to check out LibreTime for yourself is to run a local instance in a virtual machine. Assuming you already have Git, Vagrant and Virtualbox installed, just run: -1. Install Git, Vagrant and Virtualbox: -```console -$ sudo apt-get install git vagrant virtualbox -``` -2. Clone this repository locally: -```console -$ git clone https://github.com/libretime/libretime.git -``` -3. Launch the VM: -```console -$ cd libretime -$ vagrant up -``` + :::console + $ git clone https://github.com/libretime/libretime.git + $ cd libretime + $ vagrant up +Of course, this setup isn't appropriate for production use. For that, check out our [installation instructions](install.md). diff --git a/docs/install.md b/docs/install.md index d86404211..d26a1dfc7 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,8 +1,9 @@ Installing LibreTime ==================== -LibreTime should generally be installed on a dedicated host. By default, its installer will install and configure all its dependencies. +LibreTime should generally be installed on a dedicated host. By default, its installer will install and configure all its dependencies. At the moment, the installer works best on Ubuntu Trusty. -```console -$ ./installer -``` + :::console + $ ./install + +Plans are in the works for ```.deb``` and ```.rpm``` packages, as well as Docker and AWS images. diff --git a/mkdocs.yml b/mkdocs.yml index 5d7ca526d..ab3b28ee8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,6 +3,10 @@ theme: readthedocs dev_addr: '0.0.0.0:8888' site_dir: '/tmp/aegir_docs/_site' +markdown_extensions: +- codehilite: + noclasses: True + pygments_style: emacs extra_css: - '_css/term.css'