Clarify some docs and improve code highlighting.
This commit is contained in:
parent
91c581e678
commit
203716ea50
|
@ -1,17 +1,15 @@
|
||||||
pre code.console {
|
pre.codehilite > code,
|
||||||
|
div.codehilite > pre {
|
||||||
background-color: black;
|
background-color: black;
|
||||||
color: #808080;
|
color: #808080;
|
||||||
padding: 1em;
|
padding: 1em;
|
||||||
border-radius: 5px;
|
border-radius: 3px;
|
||||||
font-size: 110%;
|
font-size: 110%;
|
||||||
|
font-weight: bold;
|
||||||
overflow: auto;
|
overflow: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
span.hljs-built_in,
|
pre.codehilite > code.language-console > span,
|
||||||
span.hljs-comment,
|
div.codehilite > pre > span[style*="color: #AA22FF"] {
|
||||||
span.hljs-keyword,
|
color: #808080 !important;
|
||||||
span.hljs-variable {
|
|
||||||
color: #808080;
|
|
||||||
font-weight: normal;
|
|
||||||
font-style: normal;
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -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:
|
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
|
:::console
|
||||||
$ sudo brew install python # For OSX users
|
$ sudo brew install python # For OSX users
|
||||||
$ sudo aptitude install python-pip # For Debian/Ubuntu users
|
$ sudo aptitude install python-pip # For Debian/Ubuntu users
|
||||||
$ sudo pip install mkdocs
|
$ sudo pip install mkdocs
|
||||||
$ git clone https://github.com/libretime/libretime
|
$ git clone https://github.com/libretime/libretime
|
||||||
$ cd libretime
|
$ cd libretime
|
||||||
$ git remote add sandbox https://github.com/<username>/libretime # URL for your fork
|
$ git remote add sandbox https://github.com/<username>/libretime # URL for your fork
|
||||||
$ mkdocs build --clean
|
$ mkdocs build --clean
|
||||||
$ mkdocs serve
|
$ mkdocs serve
|
||||||
```
|
|
||||||
|
|
||||||
Your local LibreTime docs site should now be available for browsing: [http://localhost:8888/](http://localhost:8888/).
|
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:
|
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
|
:::console
|
||||||
$ git checkout -b fix_typo
|
$ git checkout -b fix_typo
|
||||||
$ vi docs/index.md # Add/edit/remove whatever you see fit. Be bold!
|
$ 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...
|
$ mkdocs build --clean; mkdocs serve # Go check your changes. We’ll wait...
|
||||||
$ git diff # Make sure there aren’t any unintended changes.
|
$ 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
|
||||||
$ 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.
|
Visit your fork on Github and start a PR.
|
||||||
|
|
|
@ -15,19 +15,11 @@ LibreTime is a fork of AirTime due to stalled development of the FLOSS version.
|
||||||
Getting Started
|
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
|
||||||
```console
|
$ git clone https://github.com/libretime/libretime.git
|
||||||
$ sudo apt-get install git vagrant virtualbox
|
$ cd libretime
|
||||||
```
|
$ vagrant up
|
||||||
2. Clone this repository locally:
|
|
||||||
```console
|
|
||||||
$ git clone https://github.com/libretime/libretime.git
|
|
||||||
```
|
|
||||||
3. Launch the VM:
|
|
||||||
```console
|
|
||||||
$ cd libretime
|
|
||||||
$ vagrant up
|
|
||||||
```
|
|
||||||
|
|
||||||
|
Of course, this setup isn't appropriate for production use. For that, check out our [installation instructions](install.md).
|
||||||
|
|
|
@ -1,8 +1,9 @@
|
||||||
Installing LibreTime
|
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
|
:::console
|
||||||
$ ./installer
|
$ ./install
|
||||||
```
|
|
||||||
|
Plans are in the works for ```.deb``` and ```.rpm``` packages, as well as Docker and AWS images.
|
||||||
|
|
|
@ -3,6 +3,10 @@ theme: readthedocs
|
||||||
|
|
||||||
dev_addr: '0.0.0.0:8888'
|
dev_addr: '0.0.0.0:8888'
|
||||||
site_dir: '/tmp/aegir_docs/_site'
|
site_dir: '/tmp/aegir_docs/_site'
|
||||||
|
markdown_extensions:
|
||||||
|
- codehilite:
|
||||||
|
noclasses: True
|
||||||
|
pygments_style: emacs
|
||||||
|
|
||||||
extra_css:
|
extra_css:
|
||||||
- '_css/term.css'
|
- '_css/term.css'
|
||||||
|
|
Loading…
Reference in New Issue