Skip to content

Commit

Permalink
doc: add mdbook for language features (WIP)
Browse files Browse the repository at this point in the history
  • Loading branch information
kthompson committed Jul 16, 2024
1 parent 0430262 commit d1e3b27
Show file tree
Hide file tree
Showing 8 changed files with 66 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
30 changes: 30 additions & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
@@ -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"]
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Generated by mdbook-autosummary v0.1.8 - do not edit manually! -->

[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)
1 change: 1 addition & 0 deletions docs/src/chapter_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Chapter 1
20 changes: 20 additions & 0 deletions docs/src/lang/basics.md
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/src/lang/chapter_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Language Tour

0 comments on commit d1e3b27

Please sign in to comment.