Skip to content
This repository has been archived by the owner on Aug 7, 2021. It is now read-only.
/ indiefeed Public archive

A static site generator theme for #IndieWeb with support for Webmentions, social readers, POSSE, and IndieAuth.

License

Notifications You must be signed in to change notification settings

dianoetic/indiefeed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IndieFeed

A Hugo theme for the independent web.

If you're like, (☉_☉) "What do all these funny words mean?" Don't worry! Read the explainer.

Screenshots

Getting Started

If you are new to the Hugo framework, fret not! It's a very popular and friendly static site generator. Check out the quickstart to create your site, then:

  1. Add this theme to your site
  2. Update your config.{toml, yaml, json}
  3. Join the IndieWeb community with your own independent site!

1. Add this theme

To add this theme to your Hugo site, run this from the root directory:

git submodule add https://github.com/dianoetic/indiefeed.git themes/indiefeed

2. Update your config

Copy the example configuration file to your root directory and update settings as needed.

Be sure to replace each example or example.com with your own domain!

3. Welcome to #indieweb! 🎉

Add some content and deploy your site! You can deploy automatically with any of these:

Once your site is deployed, you may also like to:

Categories

IndieFeed will conditionally display aspects of posts depending on the category you put in your front matter:

  • note: no title displayed
  • reply: displays title, reply icon, and includes reply markup for h-entry
  • Anything else: displays title

Preview and Validation

Serve your site locally using Hugo's development server: hugo server. See Hugo server docs for options.

Validate your h-card with IndieWebify.me.

Preview your h-feed with Monocle's preview tool.

Alternative feeds (custom output formats) can be configured in config.yaml. See the example configuration for... well, examples.

Atom and RSS can be validated with the W3C Feed Validation Service.

Customizing

Add your own CSS styles with the following setting in your config.{toml, yaml, json}:

params:
  customCSS: css/style.css # relative to ./static/

Any CSS in ./static/css/style.css will override theme defaults.

Choose a syntax highlighting theme with this setting:

markup:
  highlight:
    style: dracula

You can also override any templates by placing replacements with the same names in your ./layouts/ directory.

Contributions

Yes! All the things! ヽ(*^▽^)ノ

About

A static site generator theme for #IndieWeb with support for Webmentions, social readers, POSSE, and IndieAuth.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published