https://github.com/muxfm/site

🌍 Easily generate a static site for your podcast feed
https://github.com/muxfm/site

eleventy html jamstack podcast site staart static-site

Last synced: 22 days ago
JSON representation

🌍 Easily generate a static site for your podcast feed

• Host: GitHub
• URL: https://github.com/muxfm/site
• Owner: muxfm
• License: mit
• Created: 2020-05-01T12:48:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-08T08:27:44.000Z (over 4 years ago)
• Last Synced: 2024-11-09T18:50:23.523Z (about 1 month ago)
• Topics: eleventy, html, jamstack, podcast, site, staart, static-site
• Language: TypeScript
• Homepage: https://muxfm.js.org/docs/site/getting-started
• Size: 846 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌍 Bulwark FM Site

Easily generate a static site for your podcast feed, powered by the feed generated by [bulwarkfm/glue](https://github.com/bulwarkfm/glue).

[![Build site CI](https://github.com/bulwarkfm/site/workflows/Build%20site/badge.svg)](https://github.com/bulwarkfm/site/actions)

[**View example site →**](https://bulwarkfm.github.io/site/)

## 💡 Getting started

1. Set up a repository [using this template](https://github.com/bulwarkfm/site/generate) or fork this repository

2. Clone the repository locally and run the command `npm run setup`

3. To generate your static site, run the command `npm run build`

### Initial setup

![Screen recording of npm run setup](https://user-images.githubusercontent.com/2841780/81385438-f9957200-9130-11ea-9d47-b50aff95119d.gif)

After running `npm run build`, you can manually edit the keys in `package.json` to change the podcast description, theme colors, and sections. For more customization like adding custom sections, see the [Staart Site documentation](https://staart.js.org/site).

### Building site

To build the site, run `npm run build` and serve from the `public` folder. Run `npm run serve` to start a local development server with hot reloading.

We recommend using GitHub Actions to automatically generate and deploy your site to GitHub Pages. You can use the workflow in this repository to get started quickly.

### Example configuration

```json

{

  "@staart/site": {

    "title": "Couples Therapy with Candice and Casey",

    "baseUrl": "https://bulwarkfm.github.io/site",

    "listSubpages": true,

    "ignoreHomeSubpages": true,

    "theme": {

      "headerBackgroundColor": "#7ed6df",

      "headerTextColor": "#000000",

      "textColor": "#002024",

      "linkColor": "#000000",

      "buttonBackgroundColor": "#f9ca24",

      "buttonBackgroundColorLight": "#f6e58d",

      "buttonTextColor": "#000000",

      "doodleFillColor": "#f9ca24"

    },

    "navbar": [

      "Episodes",

      "How to Listen"

    ],

    "preFooter": [

      {

        "type": "message",

        "style": {

          "background-color": "var(--headerBackgroundColor)",

          "color": "var(--headerTextColor)",

          "padding": "5vh 0 10vh 0"

        },

        "illustration": "dancing",

        "title": "Couples Therapy with Candice and Casey is available wherever you listen to podcasts.",

        "ctaText": "Listen now →",

        "ctaLink": "https://bulwarkfm.github.io/site/listen"

      }

    ],

    "footer": {

      "text": "Hosted by Casey Neistat and Candice Pool",

      "links": [

        "RSS",

        "API"

      ]

    }

  },

  "bulwark": {

    "apiUrl": "https://bulwarkfm.github.io/glue"

  }

}

```

## 📄 License

[MIT](./LICENSE) © Bulwark FM