https://github.com/myriad-dreamin/apollo-typst

https://github.com/myriad-dreamin/apollo-typst

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/myriad-dreamin/apollo-typst
• Owner: Myriad-Dreamin
• Created: 2024-07-16T11:03:13.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-16T11:29:27.000Z (4 months ago)
• Last Synced: 2024-07-16T13:46:57.172Z (4 months ago)
• Language: JavaScript
• Size: 6.95 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# apollo-typst

Typst blog template based on [Zola](https://getzola.org), [typst.ts](https://github.com/Myriad-Dreamin/typst.ts), and [apollo](https://github.com/not-matthias/apollo).

## Features

- Full functionality of [Zola](https://getzola.org) and [apollo](https://github.com/not-matthias/apollo).

- Supports both markdown and [typst](https://typst.app/).

## Usage

### Preparation

- Install `make`, `cargo`, and `yarn`.

- Install dependencies: `yarn install`, `yarn install:bin`.

- Configure your own blog in `config.toml`. Full configuration options can be found in the [apollo documentation](https://github.com/not-matthias/apollo/blob/main/content/posts/configuration.md).

### Write posts with Typst

- Create a new typst workspace under the `typst` directory and write your post with Typst.

- Create a `.md` file in the `content` directory and write the metadata of the post in the front matter. Then, add the `extra.typst` field to the front matter, specifying the name of the typst workspace. The content of the markdown file will be ignored; instead, the content from the typst file will be utilized. For an example, refer to `content/posts/test.md`.

- If the typst output has its own title, you can set `extra.hide_title = true` to prevent zola from generating a redundant title.

### Build

```shell

# If you updated the frontend

yarn build:frontend

# If you updated the typst

yarn build:typ

# Final zola build

yarn build

```

### Develop

```shell

yarn serve

```

### Deployment[WIP]

To deploy your site to GitHub Pages, you can use the provided GitHub Action:

`.github/workflows/deploy.yml`:

```yaml

name: Deploy

on:

  push:

    branches:

      - main

jobs:

  deploy:

    runs-on: ubuntu-latest

    steps:

      - name: checkout

        uses: actions/checkout@v4

        with:

          submodules: recursive

      - uses: ../.github/actions/deploy-action@main

        with:

        access-token: ${{ secrets.ACCESS_TOKEN }}

        deploy-branch: static

    # deploy-repo: another/repo

```