Add mkdocs.

[hayd]

This also adds two static files to the build:

• mathjaxhelper.js (determine what mathjax sees as latex)
• Lapidary.css (for the moment this fixes a small annoyance which I have with mathjax rendering of LHS nav, but potentially could do some other julia-specific tweaks).

[hayd]

The alternative is to stick a copy of the README in here (Note: the index.md is required on mkdocs). I definitely like how that's generated in the rewrite branch!

[MichaelHatherly]

Thanks! Looks like I've been using 0.5-only features so travis is going to keep failing. For the moment probably best to just focus on getting this all working on 0.5 and do some compat fixes later on.

[hayd]

I've updated the branch with your change. It's much cleaner (which is great)!

We should move discussion of readme generation being circular to #12.

This works with mkdocs, but you have to turn it on at readthedocs (as I'm sure you know)!

http://lapidaryjl.readthedocs.org/en/latest/

[MichaelHatherly]

Thanks!

[MichaelHatherly]

RTDs appears to be a bit confused https://lapidaryjl.readthedocs.org/en/latest/. Or maybe I am... is this perhaps because the docs are in docs/build rather than docs?

[MichaelHatherly]

Ah, looks like it's in https://lapidaryjl.readthedocs.org/en/latest/build/index.html. I guess that's not too bad.

[hayd]

I think doc is the more usual naming convention. Perhaps we need to move to that.

Dang it looks terrible!! Is that with mkdocs checked?

[hayd]

Eurgh, why can't everyone follow the CommonMark spec for fenced blocks. Sigh.

[hayd]

Crap. That's probably my fault lol! Ok!!

It get's made plain to (ok, well github don't follow spec either! should be able to start a new fenced block with 4 `):

```
```julia
julia> a = 1
1

julia> b = 2;

julia> a + b
3
```
```

Hmmmmmmmm

[hayd]

The solution is for plain to look in code block for the max ``` sequence and do one more that that. Since:

````
```julia
julia> a = 1
1

julia> b = 2;

julia> a + b
3
```
````

is valid (and parsed correctly by mkdocs!!).

[MichaelHatherly]

I think doc is the more usual naming convention. Perhaps we need to move to that.

Fine with me. The main Julia repo names it doc so matching that would probably be for the best.

Dang it looks terrible!! Is that with mkdocs checked?

There wasn't an option to check for mkdocs that I saw. I think it gets detected automatically, maybe?

The solution is for plain to look in code block for the max ``` sequence and do one more that that.

If that looks alright everywhere then it's fine by me.

[hayd]

Posting a fix on julia shortly.

The option for mkdocs is in the admin/settings, it may be selected by default nowadays. You can also set the language (though I'm unsure if that does anything).

[hayd]

the "build" in https://lapidaryjl.readthedocs.org/en/latest/build/index.html I think means RTD is not reading the mkdocs file correctly... the LHS menu is not populated (it is with mkdocs serve), so I think there is something left to twiddle on their site.

[hayd]

In fact at the bottom of the page it says:

Built with Sphinx using a theme provided by Read the Docs.

when it should say MkDocs. http://lightgraphsjl.readthedocs.org/en/latest/

[MichaelHatherly]

Yes, mkdocs serve works for me too locally. Perhaps a RTDs/mkdocs combo problem.

[hayd]

you have to select mkdocs in the settings...

[MichaelHatherly]

I was sure that was selected when I created the site. Wasn't when I check just now. Looks much better now though, thanks.