Skip to content

Commit

Permalink
Closes #285 - Gitbook without summary (#286)
Browse files Browse the repository at this point in the history
Closes #285 - Gitbook
  • Loading branch information
wende authored Feb 6, 2018
1 parent bf8ce1d commit 874f699
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ _build/
docs/
example/
stable/
_book/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ npm install -g elchemy
Elchemy lets you write simple, fast and quality type safe code while leveraging both the Elm's safety and Elixir's ecosystem

## [You can test Elchemy online here](http://elchemy-live.herokuapp.com/) or here [Old (stable, no type checking) version](https://wende.github.io/elchemy/stable)
## [You can read Elchemy documentation here](roadmap/README.md)
## [You can read Elchemy documentation here](https://wende.gitbooks.io/elchemy/content/)
## [You can read a tutorial on using Elchemy here](https://medium.com/@krzysztof.wende/elmchemy-write-type-safe-elixir-code-with-elms-syntax-part-1-introduction-8968b76d721d)

### In case of any questions about the project feel free to submit them in Issues with Q&A label
Expand Down
3 changes: 3 additions & 0 deletions book.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"root" : "./roadmap"
}
4 changes: 2 additions & 2 deletions roadmap/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Roadmap
# Elchemy

This folder lists all of the ideas and solutions behind Elchemy to share the
This page lists all of the ideas and solutions behind Elchemy to share the
ideology as well as existing and incoming solutions to problems this project faced
or eventually will have to face

Expand Down
20 changes: 20 additions & 0 deletions roadmap/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Summary

### Documentation
* [Table Of Contents](./README.md)
* [Installations](./INSTALLATION.md)
* Basics
* [Basic Types](./BASIC_TYPES.md)
* [Defining Types](./TYPES.md)
* [Defining Type Aliases](./TYPE_ALIASES.md)
* [Defining Structures](./STRUCTURES.md)
* [Defining Modules](./MODULES.md)
* [Defining Functions](./FUNCTIONS.md)
* [Comments](./COMMENTS.md)
* Advanced
* [Side Effects / TEA](./SIDE_EFFECTS.md)
* [Unit Testing](./TESTING.md)
* [Compiler Flags](./FLAGS.md)
* [Inlining Elixir](./INLINING.md)
* Tooling
* [Troubleshooting](./TROUBLESHOOTING.md)

0 comments on commit 874f699

Please sign in to comment.