Markdown & Mermaid Test Page
This page demonstrates the enhanced markdown rendering and mermaid diagram support implemented for the HolyBPF documentation website.
Typography Tests
Headings
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Text Formatting
This is bold text and this is italic text. You can also use strikethrough and inline code.
Links and Emphasis
Here’s a link to GitHub and here’s some important information that should stand out.
Code Examples
Inline Code
Use cargo build to compile the project or call solana deploy for deployment.
Code Blocks
// HolyC to Rust interop example
pub fn hello_world() -> Result<(), ProgramError> {
msg!("Hello, World from HolyBPF!");
Ok(())
}
#[derive(Debug, Clone, Copy)]
pub struct Account {
pub owner: Pubkey,
pub lamports: u64,
pub data: Vec<u8>,
}
// HolyC BPF Program
U0 main() {
PrintF("Hello from HolyC!\n");
return 0;
}
export U0 entrypoint(U8* input, U64 input_len) {
process_instruction(input, input_len);
return;
}
# Build and deploy commands
cargo build-bpf
solana program deploy target/deploy/program.so
solana logs --follow
Lists
Unordered Lists
- First item with bold text
- Second item with italic text
- Third item with
inline code- Nested item one
- Nested item two
- Double nested item
Ordered Lists
- Set up development environment
- Install Rust
- Install Solana CLI
- Configure keypair
- Write your program
- Define data structures
- Implement business logic
- Add error handling
- Test and deploy
- Run unit tests
- Deploy to devnet
- Verify functionality
Task Lists
- Enhanced markdown rendering
- Mermaid diagram support
- Improved typography
- Advanced code highlighting
- Interactive examples
- Video tutorials
Tables
| Feature | Status | Priority | Notes |
|---|---|---|---|
| Markdown Rendering | ✅ Complete | High | All standard markdown supported |
| Mermaid Diagrams | ✅ Complete | High | Flowcharts, sequence, and more |
| Code Highlighting | ✅ Complete | Medium | Rust, HolyC, Bash support |
| Responsive Design | ✅ Complete | High | Mobile-friendly layouts |
| Table Styling | ✅ Complete | Medium | Enhanced visual presentation |
Blockquotes
Important Note: This is a blockquote demonstrating the enhanced styling with proper typography and visual hierarchy.
The essence of programming is not the language but the logic and creativity that drives innovation.
— Terry A. Davis (inspiration for HolyC)
Mermaid Diagrams
Flowchart Example
graph TB
A[HolyC Source Code] --> B[Lexical Analysis]
B --> C[Syntax Parsing]
C --> D[AST Generation]
D --> E[BPF Code Generation]
E --> F[Solana BPF Program]
subgraph "Compilation Pipeline"
B
C
D
E
end
F --> G[Deploy to Solana]
G --> H[Execute on Blockchain]
Sequence Diagram
sequenceDiagram
participant User
participant Frontend
participant Program
participant Solana
User->>Frontend: Submit Transaction
Frontend->>Program: Process Instruction
Program->>Solana: Validate Account
Solana-->>Program: Account Data
Program->>Program: Execute Logic
Program-->>Frontend: Return Result
Frontend-->>User: Display Confirmation
Architecture Diagram
graph LR
subgraph "HolyBPF Architecture"
A[HolyC Source] --> B[Compiler]
B --> C[BPF Bytecode]
C --> D[Solana Runtime]
end
subgraph "Solana Blockchain"
D --> E[Validator Nodes]
E --> F[Consensus]
F --> G[Block Production]
end
subgraph "Client Applications"
H[Web3 DApp] --> I[RPC Calls]
J[Mobile App] --> I
K[CLI Tools] --> I
I --> D
end
Alert Boxes
Info: This is an informational alert showing important details about the implementation.
Warning: Make sure to test your programs thoroughly before deploying to mainnet.
Success: Your markdown rendering is now working perfectly with enhanced styling!
Danger: Never commit private keys or sensitive information to version control.
Badges and Tags
New Feature Documentation Mermaid Markdown
Mathematical Expressions
While not implemented yet, mathematical expressions could be added with MathJax:
E = mc²f(x) = ax² + bx + c- Complex algorithms and proofs
Images and Media
Horizontal Rules
Content above the rule.
Content below the rule.
Summary
This test page demonstrates:
- Enhanced Typography - Better fonts, spacing, and hierarchy
- Improved Code Blocks - Syntax highlighting and better styling
- Rich Tables - Professional table styling with hover effects
- Mermaid Diagrams - Full support for flowcharts, sequences, and more
- Alert Boxes - Styled notification blocks
- Task Lists - Interactive checkboxes
- Responsive Design - Mobile-friendly layouts
The documentation website now provides a professional, clean, and highly readable experience for developers learning HolyBPF.