xrml 0.1.0

eXtensible Rust Markup Language — recursive acronym: HRML (HRML Markup Language) and TRML (TOML-like Markup Language)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

pub const BASE_LAYOUT: &str = include_str!("layout/base.hrml");
pub const NAV: &str = include_str!("components/nav.hrml");
pub const INDEX_PAGE: &str = include_str!("pages/index.hrml");
pub const ABOUT_PAGE: &str = include_str!("pages/about.hrml");
pub const STYLE_CSS: &str = include_str!("css/style.css");
pub const HELLO_ENDPOINT: &str = include_str!("endpoints/api/hello.hrml");

pub const VERSION: &str = "0.1.0";

use crate::config::Config;

pub fn default_config(name: &str) -> String {
    let config = Config {
        host: "127.0.0.1".to_string(),
        port: 8080,
        templates_path: "templates".to_string(),
        endpoints_path: "endpoints".to_string(),
        static_path: "static".to_string(),
        site_name: name.to_string(),
        site_description: Some("A web application built with HRML".to_string()),
        favicon: Some("/static/favicon.ico".to_string()),
        site_url: None,
        globals: serde_json::Value::Object(serde_json::Map::new()),
        default_layout: None,
        auto_imports: Vec::new(),
        component_paths: vec!["components".to_string()],
    };
    toml::to_string_pretty(&config).unwrap()
}

pub fn readme(name: &str) -> String {
    format!(
        r#"# {}

A web application built with HRML - Minimal Web Framework

## Project Structure

```
{}/
├── xrml.toml              # Configuration
├── templates/             # HTML templates
│   ├── layouts/          # Layout templates
│   ├── components/       # Reusable components
│   └── pages/            # Page templates
├── endpoints/            # Rust-native endpoint templates
│   └── api/              # API endpoints
└── static/               # Static assets
    ├── css/              # Stylesheets
    ├── js/               # JavaScript files
    └── images/           # Images
```

## Development

```bash
# Run development server with auto-reload
hrml dev

# Or serve from this directory
hrml serve
```

## Building for Production

```bash
# Build static site
hrml build

# Output will be in the `dist/` directory
```

## Adding Pages

1. Create a new template in `templates/pages/`
2. Link to it from navigation in `templates/components/nav.hrml`

## Adding API Endpoints

1. Create a `.hrml`, `.html`, or `.json` file in `endpoints/api/`
2. Optional actions can be defined as `<name>/<action>.hrml`
3. Access the endpoint at `/api/<name>/<action>`

See the HRML documentation for more details.
"#,
        name, name
    )
}

pub const GITIGNORE: &str = r#"# HRML
dist/

# Environment
.env
.env.local

"#;