millfork/mkdocs.yml

76 lines
3.2 KiB
YAML
Raw Normal View History

2019-07-15 11:52:05 +00:00
site_name: Millfork documentation
theme: readthedocs
nav:
- Home: index.md
2019-07-15 12:21:50 +00:00
- Index: doc_index.md
2019-07-15 11:52:05 +00:00
- FAQ: various/faq.md
- User guide:
- Getting started: api/getting-started.md
- Command-line option reference: api/command-line.md
- Target platform reference: api/target-platforms.md
- Defining a custom platform: api/custom-platform.md
- Differences between ROM and RAM targets: api/rom-vs-ram.md
- Platform-specific guides:
- Apple 2: api/apple2-programming-guide.md
- Amstrad CPC: api/cpc-programming-guide.md
- Commodore 64: api/commodore-programming-guide.md
- C64 with LUnix: api/lunix-programming-guide.md
- BBC Micro: api/bbcmicro-programming-guide.md
- Game Boy: api/gb-programming-guide.md
- NES/Famicom: api/famicom-programming-guide.md
2020-07-30 23:58:40 +00:00
- Color Computer: api/coco-programming-guide.md
2019-07-15 11:52:05 +00:00
- Language reference:
- Preprocessor: lang/preprocessor.md
2020-06-03 21:13:17 +00:00
- Modules: lang/modules.md
2019-07-15 11:52:05 +00:00
- Syntax: lang/syntax.md
- Types: lang/types.md
- Literals: lang/literals.md
2019-09-03 23:22:40 +00:00
- Predefined constants: lang/predefined_constants.md
- List of magic suffixes: lang/suffixes.md
2019-07-15 11:52:05 +00:00
- Text encodings: lang/text.md
2020-04-30 23:31:54 +00:00
- Custom text encodings: lang/custom-encoding.md
2019-07-15 11:52:05 +00:00
- Operators: lang/operators.md
- Functions: lang/functions.md
- Inline 6502 assembly: lang/assembly.md
- Inline 8080/LR35902/Z80 assembly: lang/assemblyz80.md
- Inline 6809 assembly: lang/assembly6809.md
2019-07-15 11:52:05 +00:00
- Reentrancy guidelines: lang/reentrancy.md
2021-03-14 23:44:14 +00:00
- Optimization hints: lang/hints.md
- List of keywords: lang/keywords.md
2019-07-15 11:52:05 +00:00
- Library reference:
- stdlib module: stdlib/stdlib.md
2020-04-05 22:44:20 +00:00
- string, scrstring and pstring modules: stdlib/string.md
2019-07-15 11:52:05 +00:00
- stdio module: stdlib/stdio.md
2020-03-31 17:07:35 +00:00
- err and random modules: stdlib/other.md
- keyboard module: stdlib/keyboard.md
- mouse and coord modules: stdlib/mouse.md
2020-03-31 17:07:35 +00:00
- joy module: stdlib/joy.md
2019-09-03 23:22:40 +00:00
- encconv module: stdlib/encconv.md
2020-03-31 17:07:35 +00:00
- Platform-dependent definitions: stdlib/frequent.md
2019-07-15 11:52:05 +00:00
- cbm_file module: stdlib/cbm_file.md
- C64-only modules: stdlib/c64.md
- VIC-20-only modules: stdlib/vic20.md
2020-03-31 17:07:35 +00:00
- PET-only modules: stdlib/cbm_pet.md
- Apple II-only modules: stdlib/apple2.md
2019-07-15 11:52:05 +00:00
- NES-only modules: stdlib/nes.md
2019-09-19 23:44:18 +00:00
- Lynx-only modules: stdlib/lynx.md
2019-07-15 11:52:05 +00:00
- Game Boyonly modules: stdlib/gb.md
2019-09-16 20:55:08 +00:00
- X16only modules: stdlib/x16.md
2019-07-15 11:52:05 +00:00
- Implementation details:
- Calling convention: abi/calling-convention.md
- Generated labels: abi/generated-labels.md
- Inlining: abi/inlining.md
- Undefined behaviour: abi/undefined-behaviour.md
- Undocumented instruction support: abi/undocumented.md
- Variable storage: abi/variable-storage.md
2020-07-24 18:09:47 +00:00
- Additional guides:
- Optimization guide: various/optimization.md
- Differences from C: various/cdiff.md
- Differences in assembly: various/asmdiff.md
2019-07-15 11:52:05 +00:00
- External links:
- Downloads: https://github.com/KarolS/millfork/releases/
- Source code: https://github.com/KarolS/millfork
- Example programs: https://github.com/KarolS/millfork/tree/master/examples
- Millfork wiki: https://github.com/KarolS/millfork/wiki
- Benchmarks: https://github.com/KarolS/millfork-benchmarks