This directory contains the complete HTML documentation for the Pangea/Pang programming language.
- index.html - Main landing page with overview and quick start
- polish-notation.html - Tutorial on Polish (prefix) notation
- evaluation.html - Deep dive into the interpreter's evaluation mechanism with animations
- examples.html - Practical code examples from Hello World to recursive functions
- reference.html - Complete language reference with all built-in words
- css/style.css - Shared stylesheet with animations and responsive design
- images/ - Directory for diagrams and illustrations (SVG embedded in HTML)
- js/ - Directory for future JavaScript interactivity
Simply open index.html in any modern web browser:
# From command line
firefox docs/index.html
# or
chromium docs/index.html
# or on macOS
open docs/index.htmlFor a better experience, serve via HTTP:
# Python 3
cd docs && python3 -m http.server 8000
# Python 2
cd docs && python -m SimpleHTTPServer 8000
# Then visit: http://localhost:8000To publish this documentation on GitHub Pages:
- Go to repository Settings → Pages
- Set source to "main" branch, "/docs" folder
- Save and wait for deployment
- Access at: https://[username].github.io/pangea/
- 📱 Responsive Design - Works on desktop, tablet, and mobile
- 🎨 CSS Animations - Visual explanations of evaluation steps
- 📊 SVG Diagrams - Parse trees and flow diagrams embedded inline
- 🌐 Bilingual - Covers both English and Italian keywords
- 💡 Interactive Examples - Expandable code samples with explanations
- Polish notation fundamentals
- Prefix vs infix comparison
- Parse tree visualization
- Evaluation order
- Tokenization (program_words)
- Phrase length calculation
- Recursive evaluation (evaluate_word)
- Call stack management
- word_definitions table structure
- 13+ complete code examples
- FizzBuzz, factorial, Fibonacci
- Variable scoping
- Function definition
- File includes
- Best practices
- All 30+ built-in words documented
- Arity and signature for each
- English/Italian translation table
- Known limitations
Current versions use quoted string literals as the canonical and only literal form.
- Removed: colon literal operator
:. - Removed: legacy
string/stringakeyword behavior. - Use quoted names for variable and function-name data, e.g.
set "x" 10,get "x",define_word "square" 1 .... - File includes now use quoted paths, e.g.
! "factorial.words". - Supported escapes in quoted strings:
\",\\,\n,\t.
To update the documentation:
- Edit the relevant HTML file
- Test locally by opening in browser
- Commit changes to git
- If using GitHub Pages, changes deploy automatically
- Use semantic HTML5 elements
- Maintain consistent color scheme (defined in CSS variables)
- Add code examples for all concepts
- Include both English and Italian versions where applicable
- Keep navigation synchronized across all pages
Tested and working on:
- Chrome/Chromium 90+
- Firefox 88+
- Safari 14+
- Edge 90+
Requires:
- CSS Grid support
- SVG support
- ES6 JavaScript (for future interactivity)
Same as Pangea/Pang: MIT License