AI vector Forge

Publishing with Markdown

This repository is pre-configured to act as a simple, powerful, and free website publishing platform using GitHub Pages. This guide walks you through how to use it to create and manage your own site.

Part 1: Choosing Your Website’s Design

Your website’s look and feel is controlled by a “theme”. This repository uses Jekyll, a static site generator, which has great support for themes.

How to Change Your Theme

You can change your website’s theme with a single line of code.

Open the _config.yml file in the root of your repository.
You will see a line: theme: jekyll-theme-primer.
To change the theme, simply replace jekyll-theme-primer with the name of another supported theme. For example: theme: jekyll-theme-minimal.
Commit the change, and your site will be rebuilt with the new theme.

Supported Themes

GitHub Pages officially supports a number of themes. You can preview them by visiting their repositories.

Theme Name	How to Use It (`_config.yml`)	Preview Link
Architect	`theme: jekyll-theme-architect`	View on GitHub
Cayman	`theme: jekyll-theme-cayman`	View on GitHub
Dinky	`theme: jekyll-theme-dinky`	View on GitHub
Hacker	`theme: jekyll-theme-hacker`	View on GitHub
Leap Day	`theme: jekyll-theme-leap-day`	View on GitHub
Merlot	`theme: jekyll-theme-merlot`	View on GitHub
Midnight	`theme: jekyll-theme-midnight`	View on GitHub
Minimal	`theme: jekyll-theme-minimal`	View on GitHub
Modernist	`theme: jekyll-theme-modernist`	View on GitHub
Primer	`theme: jekyll-theme-primer`	View on GitHub
Slate	`theme: jekyll-theme-slate`	View on GitHub
Tactile	`theme: jekyll-theme-tactile`	View on GitHub
Time Machine	`theme: jekyll-theme-time-machine`	View on GitHub

Part 2: Creating and Editing Content

The Publishing Workflow

Publishing is as simple as editing text files.

Edit or Create Files: Edit an existing Markdown (.md) file or create a new one.
Commit and Push: Save and push your changes to the main branch.
Done! The website will automatically rebuild and your changes will be live in a minute or two.

Homepage and Other Pages

Homepage: The content of your site’s homepage is the README.md file in the root of the repository.
Other Pages: Any other .md file in your repository becomes a page on your site. For example, contact.md will be available at your-site.com/contact.

Organizing Your Site

You can create folders to organize your content. A file at docs/about.md will be available at your-site.com/docs/about.

To link between pages, use relative links in your Markdown. It’s best to use paths relative to the current file (e.g., starting with ./ or ../).

For example, from your root README.md, you could link to a file in docs like this:

[Read our About page](./docs/about.md)

Part 3: Advanced Formatting

Markdown is designed to be simple, but it has powerful features for creating rich content.

Code Blocks with Syntax Highlighting

```javascript
function helloWorld() {
  console.log("Hello, world!");
}
```

Tables

| Feature         | Support Level | Notes                               |
| :-------------- | :-----------: | :---------------------------------- |
| Themes          |     Good      | Several supported themes available. |
| Markdown Tables |   Excellent   | Full support for GFM tables.        |

Task Lists

- [x] Draft the documentation.
- [ ] Add more examples.
- [ ] Request a review.

Alerts and Blockquotes

> [!NOTE]
> This is a note.
> It contains useful information users should know.

> [!WARNING]
> This is a warning.
> It advises about risks or negative outcomes.

Working with Images and Videos

Images

The standard Markdown syntax for an image is ![Alt Text](URL).

Local Images: ![A diagram of our process](./assets/process-diagram.png)
Remote Images: ![A photo of the earth from space](https://example.com/path/to/earth.jpg)

Embedding Videos

You can’t embed a video player directly, but you can create a clickable thumbnail that links to the video. Replace YOUTUBE_VIDEO_ID_HERE with your video’s ID.

[![Watch the video](https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

Page Titles and SEO

To set a custom title and description for a specific page, add a “front matter” block to the very top of your .md file.

---
title: About Our Company
description: Learn about our history, our team, and our mission.
image: /assets/our-team-photo.jpg
---
# About Us

This is the rest of your page content...

You can also set a site-wide title and description in the _config.yml file.

This site is open source. Improve this page.