Skip to content

Commit

Permalink
minor grammatical number corrections (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
waldyrious authored and fredrikekre committed May 4, 2018
1 parent e47de7d commit 5143749
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ for [Literate Programming](https://en.wikipedia.org/wiki/Literate_programming).

### What?

Literate is a package that generate markdown pages
Literate is a package that generates markdown pages
(for e.g. [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl)), and
[Jupyter notebooks](http://jupyter.org/), from the same source file. There is also
an option to "clean" the source from all metadata, and produce a pure Julia script.

The main design goal is simplicity. It should be simple to use, and the syntax should
be simple. In short, all you have to do is to write a commented julia script!

The public interface consists mainly of three functions, which all takes the same script file
as input, but generates different output:
The public interface consists mainly of three functions, all of which take the same script file
as input, but generate different output:
- [`Literate.markdown`](@ref): generates a markdown file
- [`Literate.notebook`](@ref): generates an (optionally executed) notebook
- [`Literate.script`](@ref): generates a plain script file, removing all metadata
Expand Down

0 comments on commit 5143749

Please sign in to comment.