Skip to content

Commit 12c59d9

Browse files
committed
Table of content in the readme
1 parent 98a6556 commit 12c59d9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,23 @@ Pkg.add("AcuteML")
1818
```julia
1919
using AcuteML
2020
```
21+
2122
# Documentation
2223
Click on the badge: [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://aminya.github.io/AcuteML.jl/dev)
2324

2425
See [Type Definition](https://aminya.github.io/AcuteML.jl/dev/#Main-macro-and-I/O-1) for a comprehensive introduction to syntax. You can use `@aml` macro to define a Julia type, and then the package automatically creates a xml or html associated with the defined type.
2526

27+
# Readme Content
28+
- [Installation and Usage](#installation-and-usage)
29+
- [Documentation](#documentation)
30+
- [Example - Simple](#example---simple)
31+
- [Example - Struct Definition](#example---struct-definition)
32+
- [Example - Creator](#example---creator)
33+
- [Example - Extractor](#example---extractor)
34+
- [Templating](#templating)
35+
- [Example - Template Rendering using Functions](#example---template-rendering-using-functions)
36+
- [Example - Template Rendering using Files](#example---template-rendering-using-files)
37+
2638
# Example - Simple
2739
```julia
2840
using AcuteML

0 commit comments

Comments
 (0)