index.yml

# page title
title: Webifier

# page header (is an object with title, description, background)
header:
  title: Webifier
  description: |
    Turn project content into a complete static website.

style: |
  .app-content > header:first-child h1 {
      font-family: Georgia, "Times New Roman", serif;
      font-style: italic;
      font-weight: 800;
      letter-spacing: 0;
  }

# meta tags
meta:
  patch: configurations/meta.yml

# navbar management
nav:
  patch: configurations/nav.yml

# website configuration
config:
  patch: configurations/config.yml

intro:
  label: What it is
  overview: |
    Webifier turns repository content into a static website. You keep writing
    Markdown, notebooks, YAML, HTML, PDFs, and assets where the work already
    lives; Webifier follows the links, renders the reachable pages, copies the
    assets, and produces the site.

    The point is not to replace full frontend frameworks. The point is to remove
    the publishing overhead for evolving project content: write the result,
    commit, push, and let the website update in a readable format.

    Getting started is one install command or GitHub Action away:

    ```shell
    pip install webifier
    ```

    For repository automation, see the
    [installation and GitHub Actions guide](index=pages/user-guide/tutorials/00-installation-and-github-actions.yml).

    <div class="mermaid">
    flowchart LR
      A["Work in your repository"] --> B["Add docs, notebooks, HTML, and assets"]
      B --> C["Describe the site in YAML"]
      C --> D["GitHub Actions runs Webifier"]
      D --> E["GitHub Pages serves the result"]
    </div>

    Add the action once, then let your project website evolve with the content.
    This documentation is built with Webifier and can serve as a working example
    for organizing a small docs site.

    <script type="module">
      import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
      mermaid.initialize({ startOnLoad: true, theme: "default" });
    </script>

docs:
  label: Start building
  preface: |
    This website is built with Webifier, so it is also a compact working example:
    Markdown files live under `pages/`, the homepage decides where they appear,
    and the build turns those links into pages.

    - [Start with the User Guide](index=pages/user-guide/index.yml)
    - [Install and automate with GitHub Actions](index=pages/user-guide/tutorials/00-installation-and-github-actions.yml)
    - [Browse first-party extensions](index=pages/user-guide/extensions/index.yml)

collaboration:
  label: Collaboration
  overview: |
    Webifier is most valuable when it lets people share work without building a
    website by hand. Contributions are welcome around templates, examples,
    notebook rendering, documentation patterns, and repository workflows.

    See the [collaboration page](index=pages/collaboration.yml) for concrete ways
    to help the project, share feedback, or shape useful extension examples.

    The website itself is intentionally small and source-driven, so it can be
    refactored into a clearer example as Webifier improves.