new readme (#324)

* new readme * removing doc build from travis
tlienart · Dec 25, 2019 · 4c89fd4 · tlienart · Dec 25, 2019 · 4c89fd4
1 parent 6a91cef
commit 4c89fd4
Show file tree

Hide file tree

Showing 20 changed files with 41 additions and 2,494 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -15,14 +15,3 @@ notifications:
 after_success:
   # push coverage results to Codecov
   - julia -e 'using Pkg; pkg"add Coverage"; using Coverage; Codecov.submit(Codecov.process_folder())'
-
-jobs:
-  include:
-    - stage: "Documentation"
-      julia: 1.2
-      os: linux
-      script:
-        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
-                                               Pkg.instantiate()'
-        - julia --project=docs/ docs/make.jl
-      after_success: skip
diff --git a/README.md b/README.md
@@ -1,42 +1,60 @@
-# JuDoc
-
-|        | [MacOS/Linux] | Windows | Coverage | Documentation |
-| :---:  | :-----------: | :-----: | :------: | :-----------: |
-| ![Life cycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg) | [![Build Status](https://travis-ci.org/tlienart/JuDoc.jl.svg?branch=master)](https://travis-ci.org/tlienart/JuDoc.jl) | [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/tlienart/JuDoc.jl?branch=master&svg=true)](https://ci.appveyor.com/project/tlienart/JuDoc-jl) | [![codecov.io](http://codecov.io/github/tlienart/JuDoc.jl/coverage.svg?branch=master)](http://codecov.io/github/tlienart/JuDoc.jl?branch=master) | [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://tlienart.github.io/JuDoc.jl/stable) [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://tlienart.github.io/JuDoc.jl/dev) |
+<div align="center">
+  <a href="https://tlienart.github.io/JuDocWeb/">
+    <img src="https://tlienart.github.io/JuDocWeb/assets/infra/logo1.svg" alt="JuDoc" width="200">
+  </a>
+</div>
+
+<h2 align="center">A Static Site Generator in Julia.
+<p align="center">
+  <img src="https://img.shields.io/badge/lifecycle-maturing-blue.svg"
+       alt="Lifecycle">
+  <a href="https://travis-ci.org/tlienart/JuDoc.jl">
+    <img src="https://travis-ci.org/tlienart/JuDoc.jl.svg?branch=master"
+         alt="Build Status">
+  </a>
+  <a href="http://codecov.io/github/tlienart/JuDoc.jl?branch=master">
+    <img src="http://codecov.io/github/tlienart/JuDoc.jl/coverage.svg?branch=master"
+         alt="Coverage">
+  </a>
+</p>
+</h2>
 
 JuDoc is a simple **static site generator** (SSG) oriented towards technical blogging (code, maths, ...) and light, fast-loading pages.
-The base syntax is plain markdown with a few extensions such as the ability to define and use LaTeX-like commands in or outside of maths environments.
+The base syntax is plain markdown with a few extensions such as the ability to define and use LaTeX-like commands in or outside of maths environments and the possibility to evaluate code  blocks on the fly.
+
+## Docs
+
+Go to [JuDoc's main website](https://tlienart.github.io/JuDocWeb/).
 
-See [the docs](https://tlienart.github.io/JuDoc.jl/stable) for more information.
+Some examples of websites using JuDoc
 
-A couple of websites using JuDoc:
+* the main website is written in JuDoc, [source](https://github.com/tlienart/JuDocWeb),
 * [@cormullion's website](https://cormullion.github.io), the author of [Luxor.jl](https://github.com/JuliaGraphics/Luxor.jl),
 * MLJ's [tutorial website](https://alan-turing-institute.github.io/MLJTutorials/) which shows how JuDoc can interact nicely with [Literate.jl](https://github.com/fredrikekre/Literate.jl)
+* see also [all julia blog posts](https://julialangblogmirror.netlify.com/) rendered with JuDoc thanks to massive help from [@cormullion](https://github.com/cormullion); see also the [source repo](https://github.com/cormullion/julialangblog)
 * [my website](https://tlienart.github.io).
-* see also how [some julia blog posts](https://tlienart.github.io/julia-blog-migration/) render with JuDoc (note: _focus on the rendering, not the layout/CSS_) see also [the source repo](https://github.com/tlienart/julia-blog-migration).
-  * actually see [all of them](https://julialangblogmirror.netlify.com/) rendered with JuDoc thanks to massive help from [@cormullion](https://github.com/cormullion); see also the [source repo](https://github.com/cormullion/julialangblog)
 
-### Key features
+## Key features
 
 * Use standard markdown with the possibility to use LaTeX-style commands,
 * Simple way to introduce div blocks allowing easy styling on a page (e.g. "Theorem" boxes etc.),
 * Can execute and show the output of Julia code blocks,
-* Simple optimization step to accelerate webpage loading speed:
+* Simple optimisation step to accelerate webpage loading speed:
   - compression of HTML and CSS of the generated pages,
   - optional pre-rendering of KaTeX and highlighted code blocks to remove javascript dependency,
 * Easy HTML templating to define or adapt a given layout.
 
-See [the docs](https://tlienart.github.io/JuDoc.jl/stable) for more information and examples.
+See [the docs](https://tlienart.github.io/JuDocWeb/) for more information and examples.
 
-### Quick demo
+## Getting started
 
 With Julia ≥ 1.1:
 
 ```julia
 pkg> add JuDoc
 ```
 
-and then you can get started with
+you can then get started with
 
 ```julia
 julia> using JuDoc
@@ -52,23 +70,24 @@ julia> serve()
   (use CTRL+C to shut down)
 ```
 
-You can now modify the files in `MyNewSite/src` and see the changes being live-rendered in your browser.
-Head to [the docs](https://tlienart.github.io/JuDoc.jl/stable) for more information.
+Modify the files in `MyNewSite/src` and see the changes being live-rendered in your browser.
+Head to [the docs](https://tlienart.github.io/JuDocWeb/) for more information.
 
 ## Associated repositories
 
 * [LiveServer.jl](https://github.com/asprionj/LiveServer.jl) a package coded with [Jonas Asprion](https://github.com/asprionj) to render and watch the content of a local folder in the browser.
 * [JuDocTemplates.jl](https://github.com/tlienart/JuDocTemplates.jl) the repositories where JuDoc themes/templates are developed.
+* [JuDocWeb](https://github.com/tlienart/JuDocWeb) the repository for JuDoc's website.
 
 ## Licenses
 
 **Core**:
 
-* JuDoc, JuDocTemplates and LiveServer are all MIT licensed
+* JuDoc, JuDocTemplates and LiveServer are all MIT licensed.
 
 **External**:
 
-* KaTeX is [MIT licensed](https://github.com/KaTeX/KaTeX/blob/master/LICENSE)
-* Node's is essentially [MIT licensed](https://github.com/nodejs/node/blob/master/LICENSE)
-* css-html-js-minify is [LGPL licensed](https://github.com/juancarlospaco/css-html-js-minify/blob/master/LICENCE.lgpl.txt)
-* highlight.js is [BSD licensed](https://github.com/highlightjs/highlight.js/blob/master/LICENSE)
+* KaTeX is [MIT licensed](https://github.com/KaTeX/KaTeX/blob/master/LICENSE),
+* Node's is essentially [MIT licensed](https://github.com/nodejs/node/blob/master/LICENSE),
+* css-html-js-minify is [LGPL licensed](https://github.com/juancarlospaco/css-html-js-minify/blob/master/LICENCE.lgpl.txt),
+* highlight.js is [BSD licensed](https://github.com/highlightjs/highlight.js/blob/master/LICENSE).
diff --git a/docs/Project.toml b/docs/Project.toml
diff --git a/docs/make.jl b/docs/make.jl
diff --git a/docs/src/assets/custom.css b/docs/src/assets/custom.css
diff --git a/docs/src/assets/ex-definition.png b/docs/src/assets/ex-definition.png
diff --git a/docs/src/assets/jemdoc1.png b/docs/src/assets/jemdoc1.png
diff --git a/docs/src/assets/jemdoc2.png b/docs/src/assets/jemdoc2.png
diff --git a/docs/src/assets/jemdoc3.png b/docs/src/assets/jemdoc3.png
diff --git a/docs/src/assets/jemdoc4.png b/docs/src/assets/jemdoc4.png