diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..3cee429 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,30 @@ +[book] +authors = ["Kevin Thompson"] +language = "en" +multilingual = false +src = "src" +title = "Panther Language Docs" + +# This is so that mdBook doesn't start regenerating +# deleted folders before autosummary can remove them from SUMMARY.md +[build] +create-missing = false + +[preprocessor.autosummary] + +[preprocessor.toc] +after = ["autosummary"] + +[preprocessor.admonish] +after = ["autosummary"] +command = "mdbook-admonish" +assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install` + +[preprocessor.inline-highlighting] +after = ["autosummary"] +default-language = "rust" + +[output] + +[output.html] +additional-css = ["./mdbook-admonish.css"] diff --git a/docs/LANG.md b/docs/src/LANG.md similarity index 100% rename from docs/LANG.md rename to docs/src/LANG.md diff --git a/docs/PantherIL.md b/docs/src/PantherIL.md similarity index 100% rename from docs/PantherIL.md rename to docs/src/PantherIL.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 0000000..dff0847 --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,13 @@ + + +[Panther Programming Language](index.md) +[Road map](roadmap.md) +- [Language Tour](lang/index.md) + - [Basics](lang/basics.md) + - [Data Types](lang/data-types.md) + - [Flow control](lang/flow-control.md) + - [Functions](lang/functions.md) + - [Standard library](lang/stdlib.md) +- [Notes](notes/index.md) + - [lang.md](notes/lang.md) + - [panther-il.md](notes/panther-il.md) diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md new file mode 100644 index 0000000..b743fda --- /dev/null +++ b/docs/src/chapter_1.md @@ -0,0 +1 @@ +# Chapter 1 diff --git a/docs/src/lang/basics.md b/docs/src/lang/basics.md new file mode 100644 index 0000000..76228f3 --- /dev/null +++ b/docs/src/lang/basics.md @@ -0,0 +1,20 @@ +# Basics + +- Hello world +- Modules +- Unqualified imports +- Type checking +- Ints +- Floats +- Number formats +- Equality +- Strings +- Bools +- Assignments +- Discard patterns +- Type annotations +- Type imports +- Type aliases +- Blocks +- Lists +- Constants diff --git a/docs/src/lang/chapter_1.md b/docs/src/lang/chapter_1.md new file mode 100644 index 0000000..c0b2cc3 --- /dev/null +++ b/docs/src/lang/chapter_1.md @@ -0,0 +1 @@ +# Language Tour