Skip to content

huangli712/ZenDocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About

This is the documentation for the Zen package. It is developed with the Markdown + Documenter.jl.

Prerequisites

Make sure that the Julia programming language was installed in your system and the Documenter.jl package was ready. The latest versions of them are always preferred.

Compile the docs

Just type the following command in your terminal. Here $ is only the prompt.

$ julia make.jl

The Documenter.jl will automatically generate some static webs for the documentation.

Read the docs

If everything is OK, you will find a new directory build under the docs folder. Get in it and then double click the index.html file to open it with browser (Chrome or Firefox). Enjoy it!