Publish Markdown, notebooks, HTML, PDFs, images, and static assets from the repository.
Webifier is useful because it starts from the files you already have. The site does not need to become a separate app. Your content can stay close to the code, data, notes, and outputs that produced it.
Markdown is the most natural format for notes, reports, tutorials, and docs.
Link to a Markdown file with md=... to generate a page:
[Read the notes](md=pages/notes.md)
Markdown page prefaces can provide the same page data as YAML pages:
---
title: Notes
header:
title: Notes
description: Project notes rendered as a Webifier page.
---
# Notes
The page preface can set page controls such as title, header, nav, footer,
meta, style, and page-local config.
Notebook files can be linked the same way:
[Open the analysis](md=notebooks/analysis.ipynb)
This makes Webifier a good fit for research projects, experiments, and small technical reports where the notebook is the work and the website is the sharing surface.
Notebook pages can use the same page-data shape in the first Markdown cell:
---
title: Analysis
header:
title: Analysis
nav: false
---
# Analysis
Local HTML and PDF links can be copied or rendered depending on how they are referenced. Local images and assets used by Markdown or HTML are copied into the output so the generated site remains self-contained.
Use pdf=... with webifier.pdf enabled when you want the PDF to live inside a
normal Webifier page with navigation, comments, open/download links, and a
site-styled frame:
[Read the report](pdf=reports/index.pdf)
Put page.yml beside the PDF to control the generated page title:
title: Final Report
meta:
description: Embedded PDF report.
For more detail, see Processing Pipeline.