Add a page

Start your own site

1. On GitHub, click Use this template at the top of this repository, and create your copy.
2. In your copy, open Settings > Pages, and under Build and deployment choose GitHub Actions as the source.
3. In .github/workflows/pages.yml, change site-url to your site’s address, https://<your-name>.github.io/<repository>/. The sitemap and each page’s canonical address use it.
4. Push, or run the Publish site workflow from the Actions tab. Your site appears at that address.

Add or change a page

1. Write the page in MDZip Studio, VS Code or Obsidian, and save it as an .mdz in the pages folder. Its file name becomes its address: pages/contact.mdz is published as contact.html.
2. Give it a title. The page’s title in the browser tab, and in search results, comes from the title stored in the .mdz file’s details (its manifest). Its description becomes the summary search engines show.
3. Give it a cover picture, if you like. When someone shares the page’s link, chat apps and social sites show the cover as its preview. Add a PNG or JPEG of about 1200 × 630 pixels to the .mdz, then right-click it in the editor’s file list and choose Set as Cover Image. Link previews don’t show SVG.
4. Link to other pages by their file name, like [How it works](how-it-works.mdz). The link works in your editor, and on the website it points to the web page.
5. Add the page to the menu in site/template.html, if it belongs there.
6. Commit and push. The site updates in a minute or two.

You can also edit a page on github.com: upload the new .mdz over the old one.

Change how the site looks

• Layout: site/template.html is a Pandoc template. $body$ is where the page goes, and $title$ its title.
• Style: edit site/style.css.

Things to know

• Pages are converted with Pandoc’s Markdown, which reads standard Markdown and GitHub-style tables and task lists.
• HTML in a page (like <img ... align="right">) is passed through to the web page.
• Pages in subfolders of pages are published in the same subfolders.