--- title: Getting Started description: Install sukr and build your first site weight: 0 --- This guide walks you through installing sukr and creating your first static site. ## Installation ### From source (recommended) ```bash git clone https://github.com/nrdxp/sukr cd sukr cargo install --path . ``` ### With Nix ```bash nix build github:nrdxp/sukr ./result/bin/sukr --help ``` ## Create Your First Site ### 1. Create directory structure ```bash mkdir my-site && cd my-site mkdir -p content templates static ``` ### 2. Create configuration Create `site.toml`: ```toml title = "My Site" author = "Your Name" base_url = "https://example.com" ``` ### 3. Create homepage Create `content/_index.md`: ```markdown --- title: Welcome description: My awesome site --- # Hello, World! This is my site built with sukr. ``` ### 4. Create templates Create `templates/base.html`: ```html {{ title }} | {{ config.title }}

{% block content %}{% endblock content %}

``` Create `templates/page.html`: ```html {% extends "base.html" %} {% block content %}

{% endblock content %} ``` Create `templates/content/default.html`: ```html {% extends "base.html" %} {% block content %}

{% endblock content %} ``` Your templates directory should look like this: ```text templates/ ├── base.html ├── page.html └── content/ └── default.html ``` ### 5. Build ```bash sukr ``` ### 6. View your site Open `public/index.html` in your browser. You should see your "Hello, World!" page rendered with the template you created. ## Next Steps - [Configuration](configuration.html) — customize `site.toml` options (paths, navigation, base URL) - [Content Organization](content-organization.html) — learn how directories map to site sections - [Features](features/index.html) — syntax highlighting, math, diagrams, and more

{{ page.title }}

{{ page.title }}