Skip to content

mattyod/matic-simple-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

matic-simple-example

A simple example project for Matic

Deprecated

Please see Matic-draft4-example.

Dependencies

To build this example you will need to install the following two node packages:

Matic

and

Jade

Installation

Then you can download this repository with

git clone https://github.com/mattyod/matic-simple-example.git

Building the example docs

Then simply navigate into the newly cloned example folder and run:

matic

You should now have a new folder called 'web' within the sample project. Within this should be a file called simple-example.html, open this with a browser and view the generated documentation.

Please note this particular example is built to work as a simple local flat file system and so paths are not set as they would be if files were hosted on a server. That means you can just double click the generated HTML file and view it in your default browser.

An example of the output.

About

A simple example project for Matic

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published