Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@tlienart
tlienart committed Jan 17, 2020
1 parent 9425971 commit 73eaff1
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,30 @@
<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"
<a href="https://travis-ci.org/tlienart/Franklin.jl">
<img src="https://travis-ci.org/tlienart/Franklin.jl.svg?branch=master"

This comment has been minimized.

Sign in to view

Copy link
@tlienart

tlienart Jan 17, 2020

Author Owner

@JuliaRegistrator register
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"
<a href="http://codecov.io/github/tlienart/Franklin.jl?branch=master">
<img src="http://codecov.io/github/tlienart/Franklin.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.
Franklin 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 and the possibility to evaluate code blocks on the fly.

## Docs

Go to [JuDoc's main website](https://tlienart.github.io/JuDocWeb/).
Go to [Franklin's main website](https://tlienart.github.io/JuDocWeb/).

Some examples of websites using JuDoc
Some examples of websites using Franklin

* the main website is written in JuDoc, [source](https://github.com/tlienart/JuDocWeb),
* the main website is written in Franklin, [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)
* MLJ's [tutorial website](https://alan-turing-institute.github.io/MLJTutorials/) which shows how Franklin can interact nicely with [Literate.jl](https://github.com/fredrikekre/Literate.jl)
* see also [all julia blog posts](https://julialangblogmirror.netlify.com/) rendered with Franklin 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).

## Key features
Expand All @@ -51,17 +51,17 @@ See [the docs](https://tlienart.github.io/JuDocWeb/) for more information and ex
With Julia ≥ 1.1:

```julia
pkg> add JuDoc
pkg> add Franklin
```

you can then get started with

```julia
julia> using JuDoc
julia> using Franklin

julia> newsite("MyNewSite")
✔ Website folder generated at "MyNewSite" (now the current directory).
→ Use serve() from JuDoc to see the website in your browser.
→ Use serve() from Franklin to see the website in your browser.

julia> serve()
→ Initial full pass...
Expand All @@ -76,14 +76,14 @@ 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.
* [JuDocTemplates.jl](https://github.com/tlienart/JuDocTemplates.jl) the repositories where Franklin themes/templates are developed.
* [JuDocWeb](https://github.com/tlienart/JuDocWeb) the repository for Franklin's website.

## Licenses

**Core**:

* JuDoc, JuDocTemplates and LiveServer are all MIT licensed.
* Franklin, JuDocTemplates and LiveServer are all MIT licensed.

**External**:

Expand Down

1 comment on commit 73eaff1

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/8083

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if Julia TagBot is installed, or can be done manually through the github interface, or via:

git tag -a v0.4.4 -m "<description of version>" 73eaff14c550d4d608259cfec0e0cb6df6f921d0
git push origin v0.4.4

Also, note the warning: This looks like a new registration that registers version 0.4.4.
Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.